DataGridViewCell.ParseFormattedValue Method

Definition

Converts a value formatted for display to an actual cell value.

public:
 virtual System::Object ^ ParseFormattedValue(System::Object ^ formattedValue, System::Windows::Forms::DataGridViewCellStyle ^ cellStyle, System::ComponentModel::TypeConverter ^ formattedValueTypeConverter, System::ComponentModel::TypeConverter ^ valueTypeConverter);
public virtual object ParseFormattedValue (object formattedValue, System.Windows.Forms.DataGridViewCellStyle cellStyle, System.ComponentModel.TypeConverter formattedValueTypeConverter, System.ComponentModel.TypeConverter valueTypeConverter);
public virtual object? ParseFormattedValue (object? formattedValue, System.Windows.Forms.DataGridViewCellStyle cellStyle, System.ComponentModel.TypeConverter? formattedValueTypeConverter, System.ComponentModel.TypeConverter? valueTypeConverter);
abstract member ParseFormattedValue : obj * System.Windows.Forms.DataGridViewCellStyle * System.ComponentModel.TypeConverter * System.ComponentModel.TypeConverter -> obj
override this.ParseFormattedValue : obj * System.Windows.Forms.DataGridViewCellStyle * System.ComponentModel.TypeConverter * System.ComponentModel.TypeConverter -> obj
Public Overridable Function ParseFormattedValue (formattedValue As Object, cellStyle As DataGridViewCellStyle, formattedValueTypeConverter As TypeConverter, valueTypeConverter As TypeConverter) As Object

Parameters

formattedValue
Object

The display value of the cell.

cellStyle
DataGridViewCellStyle

The DataGridViewCellStyle in effect for the cell.

formattedValueTypeConverter
TypeConverter

A TypeConverter for the display value type, or null to use the default converter.

valueTypeConverter
TypeConverter

A TypeConverter for the cell value type, or null to use the default converter.

Returns

The cell value.

Exceptions

cellStyle is null.

The FormattedValueType property value is null.

-or-

The ValueType property value is null.

-or-

formattedValue cannot be converted.

formattedValue is null.

-or-

The type of formattedValue does not match the type indicated by the FormattedValueType property.

Remarks

When the user edits a cell value and commits the change, the DataGridView control calls this method to convert the displayed value from the FormattedValueType to the ValueType. The control then sets the underlying cell value or data source value to the converted value.

The default implementation of this method parses the formattedValue parameter using the NullValue, DataSourceNullValue, and FormatProvider properties of the cell style indicated by the cellStyle parameter.

If formattedValue is equal to NullValue, this method returns the value of the DataSourceNullValue property or null if DataSourceNullValue is DBNull.Value and the cell ValueType is a reference type.

If formattedValue is not equal to NullValue, this method parses formattedValue using the FormatProvider property and the specified or default converters.

If the cell ValueType is nullable, this method wraps the return value as a Nullable<T> type.

Applies to

See also