DataGridViewCell.GetEditedFormattedValue Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the current, formatted value of the cell, regardless of whether the cell is in edit mode and the value has not been committed.

public:
 System::Object ^ GetEditedFormattedValue(int rowIndex, System::Windows::Forms::DataGridViewDataErrorContexts context);

public object GetEditedFormattedValue (int rowIndex, System.Windows.Forms.DataGridViewDataErrorContexts context);

public object? GetEditedFormattedValue (int rowIndex, System.Windows.Forms.DataGridViewDataErrorContexts context);

member this.GetEditedFormattedValue : int * System.Windows.Forms.DataGridViewDataErrorContexts -> obj

Public Function GetEditedFormattedValue (rowIndex As Integer, context As DataGridViewDataErrorContexts) As Object

Parameters

rowIndex: Int32

The row index of the cell.

context: DataGridViewDataErrorContexts

A bitwise combination of DataGridViewDataErrorContexts values that specifies the data error context.

Returns

Object

The current, formatted value of the DataGridViewCell.

Exceptions

ArgumentOutOfRangeException

The specified rowIndex is less than 0 or greater than the number of rows in the control minus 1.

InvalidOperationException

ColumnIndex is less than 0, indicating that the cell is a row header cell.

Exception

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.

Remarks

This method returns the current value of the editing cell or editing control if the cell is in edit mode. Otherwise, this method converts the cell value into an equivalent display value of the type indicated by the FormattedValueType property. This raises the DataGridView.CellFormatting event, which you can handle to customize the value conversion.

If formatting 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.

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

Applies to