DataGridViewCell.GetFormattedValue(Object, Int32, DataGridViewCellStyle, TypeConverter, TypeConverter, DataGridViewDataErrorContexts) メソッド

定義

表示用に書式指定済みのセル値を取得します。Gets the value of the cell as formatted for display.

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);
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

書式指定される値。The value to be formatted.

rowIndex
Int32

セルの親行のインデックス。The index of the cell's parent row.

cellStyle
DataGridViewCellStyle

セルに反映される DataGridViewCellStyleThe DataGridViewCellStyle in effect for the cell.

valueTypeConverter
TypeConverter

書式指定済みの値の型へカスタムの変換を実行する、元の値の型に関連付けられた TypeConverter。カスタムの変換が不要な場合は nullA TypeConverter associated with the value type that provides custom conversion to the formatted value type, or null if no such custom conversion is needed.

formattedValueTypeConverter
TypeConverter

書式指定済みの値の型からカスタムの変換を実行する、その値の型に関連付けられた TypeConverter。カスタムの変換が不要な場合は nullA TypeConverter associated with the formatted value type that provides custom conversion from the value type, or null if no such custom conversion is needed.

context
DataGridViewDataErrorContexts

書式指定済みの値が必要とされているコンテキストを示す DataGridViewDataErrorContexts 値のビットごとの組み合わせ。A bitwise combination of DataGridViewDataErrorContexts values describing the context in which the formatted value is needed.

戻り値

書式指定済みのセル値。または、セルが DataGridView コントロールに属していない場合は nullThe formatted value of the cell or null if the cell does not belong to a DataGridView control.

例外

書式指定が失敗し、DataError コントロールの DataGridView イベントのハンドラーが定義されていないか、ハンドラーで ThrowException プロパティが true に設定されました。Formatting failed and either there is no handler for the DataError event of the DataGridView control or the handler set the ThrowException property to true. 通常、例外オブジェクトは型 FormatException にキャストできます。The exception object can typically be cast to type FormatException.

注釈

DataGridView コントロールは、このメソッドを呼び出して、セル値を、FormattedValueType プロパティによって示される型の等価の表示値に変換します。The DataGridView control calls this method to convert a cell value into an equivalent display value of the type indicated by the FormattedValueType property. コントロールは、value パラメーターのこのメソッドにセル値を渡します。The control passes the cell value to this method in the value parameter.

このメソッドは、DataGridView.CellFormatting イベントを発生させます。This method raises the DataGridView.CellFormatting event. このイベントのハンドラーは、valuecellStyle の両方のパラメーターを変更できます。A handler for this event can modify both the value and cellStyle parameters. ただし、ハンドラーが DataGridViewCellFormattingEventArgs.FormattingApplied プロパティを trueに設定していない場合、このメソッドは cellStyle オブジェクトの書式設定プロパティを使用して value 書式設定します。If the handler does not set the DataGridViewCellFormattingEventArgs.FormattingApplied property to true, however, this method formats value using the formatting properties of the cellStyle object.

注意

このメソッドは、DataSourceNullValueDBNull.Value または null以外の値に設定されている場合に、DataGridViewCellStyle.DataSourceNullValue プロパティ値と等しい値の DataGridViewCellStyle.NullValue プロパティ値に value を変換しません。This method does not convert value to the DataGridViewCellStyle.NullValue property value for values equal to the DataGridViewCellStyle.DataSourceNullValue property value when DataSourceNullValue is set to a value other than DBNull.Value or null. この場合は、DataGridView.CellFormatting イベントを処理して、NullValue プロパティ値を表示できます。In this case, you can handle the DataGridView.CellFormatting event to display the NullValue property value. 詳細については、「DataSourceNullValue」のコード例を参照してください。For more information, see the code example in DataSourceNullValue.

書式設定に失敗した場合は、DataError イベントが発生します。If formatting is unsuccessful, the DataError event occurs. このイベントのハンドラーがない場合、またはハンドラーが DataGridViewDataErrorEventArgs.ThrowException プロパティを trueに設定した場合は、例外がスローされます。If there is no handler for this event or the handler sets the DataGridViewDataErrorEventArgs.ThrowException property to true, an exception is thrown.

このメソッドをオーバーライドする派生クラスは、通常、context 引数に ClipboardContent 値が含まれている場合に、セル値の文字列形式を返します。Derived classes that override this method will typically return a string representation of the cell value if the context argument includes the ClipboardContent value.

適用対象

こちらもご覧ください