DataGridViewComboBoxCell.GetFormattedValue 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.

Gets the formatted value of the cell's data.

protected:
 override System::Object ^ GetFormattedValue(System::Object ^ value, int rowIndex, System::Windows::Forms::DataGridViewCellStyle ^ % cellStyle, System::ComponentModel::TypeConverter ^ valueTypeConverter, System::ComponentModel::TypeConverter ^ formattedValueTypeConverter, System::Windows::Forms::DataGridViewDataErrorContexts context);

protected override object GetFormattedValue (object value, int rowIndex, ref System.Windows.Forms.DataGridViewCellStyle cellStyle, System.ComponentModel.TypeConverter valueTypeConverter, System.ComponentModel.TypeConverter formattedValueTypeConverter, System.Windows.Forms.DataGridViewDataErrorContexts context);

protected override object? GetFormattedValue (object? value, int rowIndex, ref System.Windows.Forms.DataGridViewCellStyle cellStyle, System.ComponentModel.TypeConverter? valueTypeConverter, System.ComponentModel.TypeConverter? formattedValueTypeConverter, System.Windows.Forms.DataGridViewDataErrorContexts context);

override this.GetFormattedValue : obj * int * DataGridViewCellStyle * System.ComponentModel.TypeConverter * System.ComponentModel.TypeConverter * System.Windows.Forms.DataGridViewDataErrorContexts -> obj

Protected Overrides Function GetFormattedValue (value As Object, rowIndex As Integer, ByRef cellStyle As DataGridViewCellStyle, valueTypeConverter As TypeConverter, formattedValueTypeConverter As TypeConverter, context As DataGridViewDataErrorContexts) As Object

Parameters

value: Object

The value to be formatted.

rowIndex: Int32

The index of the cell's parent row.

cellStyle: DataGridViewCellStyle

The DataGridViewCellStyle in effect for the cell.

valueTypeConverter: 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: 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: DataGridViewDataErrorContexts

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

Returns

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.

Exceptions

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 for type conversion errors or to type ArgumentException if value cannot be found in the DataSource or the Items collection.

Remarks

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 determines whether value is valid by determining whether one of the following conditions is met.

value is present in the DataSource or the Items collection.
value is null or DBNull.Value.
value is String.Empty and the ValueType property value represents the String type.

If value is not valid, 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 value is valid 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, this method returns the formatted value for display in the DataGridView control.

Applies to