DataGridViewCell.GetFormattedValue メソッド

  • リファレンス

定義

名前空間:
System.Windows.Forms
アセンブリ:
System.Windows.Forms.dll

表示用に書式指定済みのセル値を取得します。

protected:
 virtual System::Object ^ GetFormattedValue(System::Object ^ value, int rowIndex, System::Windows::Forms::DataGridViewCellStyle ^ % cellStyle, System::ComponentModel::TypeConverter ^ valueTypeConverter, System::ComponentModel::TypeConverter ^ formattedValueTypeConverter, System::Windows::Forms::DataGridViewDataErrorContexts context);
protected virtual object GetFormattedValue (object value, int rowIndex, ref System.Windows.Forms.DataGridViewCellStyle cellStyle, System.ComponentModel.TypeConverter valueTypeConverter, System.ComponentModel.TypeConverter formattedValueTypeConverter, System.Windows.Forms.DataGridViewDataErrorContexts context);
protected virtual object? GetFormattedValue (object? value, int rowIndex, ref System.Windows.Forms.DataGridViewCellStyle cellStyle, System.ComponentModel.TypeConverter? valueTypeConverter, System.ComponentModel.TypeConverter? formattedValueTypeConverter, System.Windows.Forms.DataGridViewDataErrorContexts context);
abstract member GetFormattedValue : obj * int * DataGridViewCellStyle * System.ComponentModel.TypeConverter * System.ComponentModel.TypeConverter * System.Windows.Forms.DataGridViewDataErrorContexts -> obj
override this.GetFormattedValue : obj * int * DataGridViewCellStyle * System.ComponentModel.TypeConverter * System.ComponentModel.TypeConverter * System.Windows.Forms.DataGridViewDataErrorContexts -> obj
Protected Overridable Function GetFormattedValue (value As Object, rowIndex As Integer, ByRef cellStyle As DataGridViewCellStyle, valueTypeConverter As TypeConverter, formattedValueTypeConverter As TypeConverter, context As DataGridViewDataErrorContexts) As Object

パラメーター

value
Object

書式指定される値。

rowIndex
Int32

セルの親行のインデックス。

cellStyle
DataGridViewCellStyle

セルに反映される DataGridViewCellStyle

valueTypeConverter
TypeConverter

書式指定済みの値の型へカスタムの変換を実行する、元の値の型に関連付けられた TypeConverter。カスタムの変換が不要な場合は null。

formattedValueTypeConverter
TypeConverter

書式指定済みの値の型からカスタムの変換を実行する、その値の型に関連付けられた TypeConverter。カスタムの変換が不要な場合は null。

context
DataGridViewDataErrorContexts

書式指定済みの値が必要とされているコンテキストを示す DataGridViewDataErrorContexts 値のビットごとの組み合わせ。

戻り値

Object

書式指定済みのセル値。または、セルが DataGridView コントロールに属していない場合は null。

例外

Exception

書式指定が失敗し、DataError コントロールの DataGridView イベントのハンドラーが定義されていないか、ハンドラーで ThrowException プロパティが true に設定されました。 通常、例外オブジェクトは型 FormatException にキャストできます。

注釈

コントロールは DataGridView 、このメソッドを呼び出して、セル値を プロパティによって示される型の同等の表示値に FormattedValueType 変換します。 コントロールは、 パラメーター内のこのメソッドにセル値を value 渡します。

このメソッドは イベントを DataGridView.CellFormatting 発生させます。 このイベントのハンドラーは、 パラメーターと cellStyle パラメーターの両方をvalue変更できます。 ただし、ハンドラーで プロパティが DataGridViewCellFormattingEventArgs.FormattingApplied に true設定されていない場合、このメソッド value は オブジェクトの書式設定プロパティを使用して書式を cellStyle 設定します。

注意

が または 以外の値に設定されている場合DataSourceNullValue、このメソッドは、プロパティ値とDataGridViewCellStyle.DataSourceNullValue等しい値のプロパティ値に変換valueしません。DataGridViewCellStyle.NullValueDBNull.Valuenull この場合は、 イベントを DataGridView.CellFormatting 処理してプロパティ値を NullValue 表示できます。 詳細については、「DataSourceNullValue」のコード例を参照してください。

書式設定が失敗した場合、イベントが DataError 発生します。 このイベントのハンドラーがない場合、またはハンドラーによって プロパティが DataGridViewDataErrorEventArgs.ThrowException に true設定されている場合は、例外がスローされます。

通常、このメソッドをオーバーライドする派生クラスは、引数に 値が含まれている場合、セル値の context 文字列表現を ClipboardContent 返します。

適用対象

こちらもご覧ください