DataGridViewCell.GetFormattedValue 方法

定义

获取为显示进行格式化的单元格的值。

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 值的按位组合,用于描述需要格式化值的上下文。

返回

单元格的格式化值;如果该单元格不属于 DataGridView 控件,则为 null

例外

格式化失败,这是由于 DataError 控件的 DataGridView 事件无处理程序或处理程序将 ThrowException 属性设置为 true 而引起的。 通常情况下,可将该异常对象强制转换为类型 FormatException

注解

控件 DataGridView 调用此方法可将单元格值转换为 属性指示 FormattedValueType 的 类型的等效显示值。 控件将单元格值传递到 参数中的 value 此方法。

此方法引发 DataGridView.CellFormatting 事件。 此事件的处理程序可以修改 valuecellStyle 参数。 但是,如果处理程序未将 DataGridViewCellFormattingEventArgs.FormattingApplied 属性设置为 true,则此方法使用 对象的格式设置属性cellStyle进行格式value设置。

注意

当 设置为 或 null以外的DBNull.Value值时DataSourceNullValueDataGridViewCellStyle.DataSourceNullValue此方法不会将 等于属性值转换为valueDataGridViewCellStyle.NullValue属性值。 在这种情况下,可以处理 DataGridView.CellFormatting 事件以显示 NullValue 属性值。 有关详细信息,请参阅DataSourceNullValue中的代码示例。

如果格式设置不成功,则会发生 该 DataError 事件。 如果此事件没有处理程序,或者处理程序将 DataGridViewDataErrorEventArgs.ThrowException 属性设置为 true,则会引发异常。

如果 context 参数包含 ClipboardContent 值,重写此方法的派生类通常会返回单元格值的字符串表示形式。

适用于

另请参阅