Export (0) Print
Expand All

DataGridViewCheckBoxCell.GetFormattedValue Method

Gets the formatted value of the cell's data.

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

protected override Object GetFormattedValue(
	Object value,
	int rowIndex,
	ref DataGridViewCellStyle cellStyle,
	TypeConverter valueTypeConverter,
	TypeConverter formattedValueTypeConverter,
	DataGridViewDataErrorContexts context
)

Parameters

value
Type: System.Object

The value to be formatted.

rowIndex
Type: System.Int32

The index of the cell's parent row.

cellStyle
Type: System.Windows.Forms.DataGridViewCellStyle

The DataGridViewCellStyle in effect for the cell.

valueTypeConverter
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.

formattedValueTypeConverter
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.

context
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 value of the cell's data after formatting has been applied or null if the cell is not part of a DataGridView control.

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 first attempts to convert value to a Boolean or CheckState value using the TrueValue, FalseValue, and IndeterminateValue properties if they have been set.

If the conversion is unsuccessful, the DataGridView.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.

If the conversion is successful or there is a handler for the DataError event and it does not set the DataGridViewDataErrorEventArgs.ThrowException property to true, the DataGridView.CellFormatting event occurs.

A CellFormatting event handler can modify both value and cellStyle. 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 can result in an additional DataError event.

If formatting is successful and the context parameter value includes the ClipboardContent value, this method returns the String version of the formatted value for copying to the Clipboard. Otherwise, this method returns the formatted value for display in the DataGridView control.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft