This documentation is archived and is not being maintained.

IDataGridViewEditingControl.GetEditingControlFormattedValue Method

Retrieves the formatted value of the cell.

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

Object GetEditingControlFormattedValue(
	DataGridViewDataErrorContexts context
)

Parameters

context
Type: System.Windows.Forms.DataGridViewDataErrorContexts
A bitwise combination of DataGridViewDataErrorContexts values that specifies the context in which the data is needed.

Return Value

Type: System.Object
An Object that represents the formatted version of the cell contents.

The formatted value represents the value as it is displayed in the control's user interface. The formatted value may be different in absolute value and even data type from the actual value contained in the control.

To set the formatted value of the control, use the EditingControlFormattedValue property.

Notes to Implementers

Changing the return value in your implementation of this method does not automatically change the displayed value. When the value changes in the editing control, you must notify the DataGridView of the change by passing true to the DataGridView.NotifyCurrentCellDirty method.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: