DataGridViewCell.GetFormattedValue(Object, Int32, DataGridViewCellStyle, TypeConverter, TypeConverter, DataGridViewDataErrorContexts) Método

Definición

Obtiene el valor de la celda con el formato para mostrar.Gets the value of the cell as formatted for display.

protected:
 virtual 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 virtual 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);
abstract member GetFormattedValue : obj * int * DataGridViewCellStyle * System.ComponentModel.TypeConverter * System.ComponentModel.TypeConverter * System.Windows.Forms.DataGridViewDataErrorContexts -> obj
override this.GetFormattedValue : obj * int * DataGridViewCellStyle * System.ComponentModel.TypeConverter * System.ComponentModel.TypeConverter * System.Windows.Forms.DataGridViewDataErrorContexts -> obj
Protected Overridable Function GetFormattedValue (value As Object, rowIndex As Integer, ByRef cellStyle As DataGridViewCellStyle, valueTypeConverter As TypeConverter, formattedValueTypeConverter As TypeConverter, context As DataGridViewDataErrorContexts) As Object

Parámetros

value
Object

Valor al que se debe dar formato.The value to be formatted.

rowIndex
Int32

Índice de la fila primaria de la celda.The index of the cell's parent row.

cellStyle
DataGridViewCellStyle

Clase DataGridViewCellStyle en vigor para la celda.The DataGridViewCellStyle in effect for the cell.

valueTypeConverter
TypeConverter

TypeConverter asociado al tipo de valor que proporciona la conversión personalizada al tipo de valor con formato; o bien, null si no es necesaria esa conversión personalizada.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

TypeConverter asociado al tipo de valor con formato que proporciona la conversión personalizada desde el tipo de valor; o bien, null si no es necesaria esa conversión personalizada.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

Una combinación bit a bit de valores DataGridViewDataErrorContexts que describen el contexto en el que es necesario el valor con formato.A bitwise combination of DataGridViewDataErrorContexts values describing the context in which the formatted value is needed.

Devoluciones

Valor con formato de la celda o null si la celda no pertenece a un control DataGridView.The formatted value of the cell or null if the cell does not belong to a DataGridView control.

Excepciones

Se ha producido un error al dar formato y, o bien no hay ningún controlador para el evento DataError del control DataGridView, o el controlador ha establecido la propiedad ThrowException en true.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. El objeto de excepción normalmente se puede convertir al tipo FormatException.The exception object can typically be cast to type FormatException.

Comentarios

El control DataGridView llama a este método para convertir un valor de celda en un valor de presentación equivalente del tipo indicado por la propiedad FormattedValueType.The DataGridView control calls this method to convert a cell value into an equivalent display value of the type indicated by the FormattedValueType property. El control pasa el valor de la celda a este método en el parámetro value.The control passes the cell value to this method in the value parameter.

Este método genera el evento DataGridView.CellFormatting.This method raises the DataGridView.CellFormatting event. Un controlador para este evento puede modificar los parámetros value y cellStyle.A handler for this event can modify both the value and cellStyle parameters. Sin embargo, si el controlador no establece la propiedad DataGridViewCellFormattingEventArgs.FormattingApplied en true, este método da formato a value utilizando las propiedades de formato del objeto 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.

Nota

Este método no convierte value en el valor de la propiedad DataGridViewCellStyle.NullValue para los valores iguales al valor de la propiedad DataGridViewCellStyle.DataSourceNullValue cuando DataSourceNullValue se establece en un valor distinto de DBNull.Value o null.This method does not convert value to the DataGridViewCellStyle.NullValue property value for values equal to the DataGridViewCellStyle.DataSourceNullValue property value when DataSourceNullValue is set to a value other than DBNull.Value or null. En este caso, puede controlar el evento DataGridView.CellFormatting para mostrar el valor de la propiedad NullValue.In this case, you can handle the DataGridView.CellFormatting event to display the NullValue property value. Para más información y ver un código de ejemplo, vea DataSourceNullValue.For more information, see the code example in DataSourceNullValue.

Si el formato no es correcto, se produce el evento DataError.If formatting is unsuccessful, the DataError event occurs. Si no hay ningún controlador para este evento o el controlador establece la propiedad DataGridViewDataErrorEventArgs.ThrowException en true, se produce una excepción.If there is no handler for this event or the handler sets the DataGridViewDataErrorEventArgs.ThrowException property to true, an exception is thrown.

Las clases derivadas que invalidan este método normalmente devolverán una representación de cadena del valor de celda si el argumento context incluye el valor ClipboardContent.Derived classes that override this method will typically return a string representation of the cell value if the context argument includes the ClipboardContent value.

Se aplica a

Consulte también: