DataGridViewCell.GetFormattedValue Method (Object, Int32, DataGridViewCellStyle, TypeConverter, TypeConverter, DataGridViewDataErrorContexts)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Gets the value of the cell as formatted for display.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

protected virtual object GetFormattedValue(
	object value,
	int rowIndex,
	ref DataGridViewCellStyle cellStyle,
	TypeConverter valueTypeConverter,
	TypeConverter formattedValueTypeConverter,
	DataGridViewDataErrorContexts context


Type: System.Object

The value to be formatted.

Type: System.Int32

The index of the cell's parent row.

Type: System.Windows.Forms.DataGridViewCellStyle

The DataGridViewCellStyle in effect for the cell.

Type: System.ComponentModel.TypeConverter

A TypeConverter associated with the value type that provides custom conversion to the formatted value type, or null if no such custom conversion is needed.

Type: System.ComponentModel.TypeConverter

A TypeConverter associated with the formatted value type that provides custom conversion from the value type, or null if no such custom conversion is needed.

Type: System.Windows.Forms.DataGridViewDataErrorContexts

A bitwise combination of DataGridViewDataErrorContexts values describing the context in which the formatted value is needed.

Return Value

Type: System.Object

The formatted value of the cell or null if the cell does not belong to a DataGridView control.

Exception Condition

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. The exception object can typically be cast to type FormatException.

The DataGridView control calls this method to convert a cell value into an equivalent display value of the type indicated by the FormattedValueType property. The control passes the cell value to this method in the value parameter.

This method raises the DataGridView.CellFormatting event. A handler for this event can modify both the value and cellStyle parameters. 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.


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. In this case, you can handle the DataGridView.CellFormatting event to display the NullValue property value. For more information, see the code example in DataSourceNullValue.

If formatting is unsuccessful, the DataError event occurs. If there is no handler for this event or the handler sets the DataGridViewDataErrorEventArgs.ThrowException property to true, an exception is thrown.

Derived classes that override this method will typically return a string representation of the cell value if the context argument includes the ClipboardContent value.

.NET Framework
Available since 2.0
Return to top