DataGridViewCell.GetClipboardContent メソッド

.NET Framework クラス ライブラリ リファレンス

DataGridViewCell.GetClipboardContent メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

Clipboard にコピーするセルの書式指定済みの値を取得します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Protected Overridable Function
 GetClipboardContent ( _
    rowIndex As Integer, _
    firstCell As Boolean, _
    lastCell As Boolean, _
    inFirstRow As Boolean, _
    inLastRow As Boolean, _
    format As String _
) As Object

Visual Basic (使用法)

Dim rowIndex As Integer
Dim firstCell As Boolean
Dim lastCell As Boolean
Dim inFirstRow As Boolean
Dim inLastRow As Boolean
Dim format As String
Dim returnValue As Object

returnValue = Me.GetClipboardContent(rowIndex, firstCell, lastCell,
 inFirstRow, inLastRow, format)

C#

protected virtual Object GetClipboardContent (
    int rowIndex,
    bool firstCell,
    bool lastCell,
    bool inFirstRow,
    bool inLastRow,
    string format
)

C++

protected:
virtual Object^ GetClipboardContent (
    int rowIndex, 
    bool firstCell, 
    bool lastCell, 
    bool inFirstRow, 
    bool inLastRow, 
    String^ format
)

J#

protected Object GetClipboardContent (
    int rowIndex, 
    boolean firstCell, 
    boolean lastCell, 
    boolean inFirstRow, 
    boolean inLastRow, 
    String format
)

JScript

protected function GetClipboardContent (
    rowIndex : int, 
    firstCell : boolean, 
    lastCell : boolean, 
    inFirstRow : boolean, 
    inLastRow : boolean, 
    format : String
) : Object

パラメータ

rowIndex

セルを含む行の、0 から始まるインデックス番号。

firstCell

選択したセルによって定義される領域の最初の列にセルがある場合は true。それ以外の場合は false。

lastCell

選択したセルによって定義される領域の最後の列にセルがある場合は true。それ以外の場合は false。

inFirstRow

選択したセルによって定義される領域の最初の行にセルがある場合は true。それ以外の場合は false。

inLastRow

選択したセルによって定義される領域の最後の行にセルがある場合は true。それ以外の場合は false。

format

セルの現在の書式指定文字列。

戻り値
Clipboard にコピーするセルの値を表す Object。

例外

例外の種類	条件
ArgumentOutOfRangeException	rowIndex が 0 未満か、コントロールに含まれている行数以上です。
InvalidOperationException	セルの DataGridView プロパティの値が null 参照 (Visual Basic では Nothing) です。 または ColumnIndex が 0 未満です。これは、セルが行ヘッダーのセルであることを示します。
Exception	書式指定が失敗し、DataGridView コントロールの DataError イベントのハンドラが定義されていないか、ハンドラで ThrowException プロパティが true に設定されました。例外オブジェクトは通常、FormatException 型にキャストできます。

解説

このメソッドは、セル値を表すクリップボード形式の値を取得するために、DataGridView.GetClipboardContent メソッドによって呼び出されます。

セル値は、最初にその表示形式で GetEditedFormattedValue メソッドから取得されます。これにより、値の書式を設定するための DataGridView.CellFormatting イベント、および書式設定が失敗した場合は DataGridView.DataError イベントが発生することがあります。

このメソッドの位置に関連するパラメータは、DataGridView コントロール内で選択されたセルによって定義される領域を表すデータ テーブルにおいて、このセルがどの位置にあるのかを示します。セルの位置によっては、このメソッドによって、表示形式のセル値の他に追加の書式指定情報も返される場合があります。たとえば、行の最初の列にあるセルの HTML 形式には、行の始まりを示すタグが含まれています。

サポートされているクリップボード形式は、DataFormats.Text、DataFormats.UnicodeText、DataFormats.Html、および DataFormats.CommaSeparatedValue です。

詳細については、Clipboard クラスのトピックを参照してください。

継承時の注意 カスタマイズされたクリップボード値を指定するには、このメソッドをオーバーライドします。たとえば、このメソッドをオーバーライドして、カスタムのセル型からの値のコピーをサポートできます。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
DataGridViewCell クラス
DataGridViewCell メンバ
System.Windows.Forms 名前空間
DataGridView クラス
DataFormats クラス
DataGridView.ClipboardCopyMode プロパティ
DataGridViewClipboardCopyMode