DataGridView.CellFormatting Evento

Definición

Tiene lugar cuando es necesario dar formato al contenido de una celda para mostrarlo.Occurs when the contents of a cell need to be formatted for display.

public:
 event System::Windows::Forms::DataGridViewCellFormattingEventHandler ^ CellFormatting;
public event System.Windows.Forms.DataGridViewCellFormattingEventHandler CellFormatting;
member this.CellFormatting : System.Windows.Forms.DataGridViewCellFormattingEventHandler 
Public Custom Event CellFormatting As DataGridViewCellFormattingEventHandler 

Ejemplos

En el ejemplo de código siguiente se muestra cómo controlar el evento CellFormatting.The following code example shows how to handle the CellFormatting event.

void dataGridView1_CellFormatting( Object^ /*sender*/, DataGridViewCellFormattingEventArgs^ e )
{
   // If the column is the Artist column, check the
   // value.
   if ( this->dataGridView1->Columns[ e->ColumnIndex ]->Name->Equals( "Artist" ) )
   {
      if ( e->Value != nullptr )
      {
         // Check for the string "pink" in the cell.
         String^ stringValue = dynamic_cast<String^>(e->Value);
         stringValue = stringValue->ToLower();
         if ( (stringValue->IndexOf( "pink" ) > -1) )
         {
            DataGridViewCellStyle^ pinkStyle = gcnew DataGridViewCellStyle;

            //Change the style of the cell.
            pinkStyle->BackColor = Color::Pink;
            pinkStyle->ForeColor = Color::Black;
            pinkStyle->Font = gcnew System::Drawing::Font( "Times New Roman",8,FontStyle::Bold );
            e->CellStyle = pinkStyle;
         }
         
      }
   }
   else
   if ( this->dataGridView1->Columns[ e->ColumnIndex ]->Name->Equals( "Release Date" ) )
   {
      ShortFormDateFormat( e );
   }
}


//Even though the date internaly stores the year as YYYY, using formatting, the
//UI can have the format in YY.  
void ShortFormDateFormat( DataGridViewCellFormattingEventArgs^ formatting )
{
   if ( formatting->Value != nullptr )
   {
      try
      {
         System::Text::StringBuilder^ dateString = gcnew System::Text::StringBuilder;
         DateTime theDate = DateTime::Parse( formatting->Value->ToString() );
         dateString->Append( theDate.Month );
         dateString->Append( "/" );
         dateString->Append( theDate.Day );
         dateString->Append( "/" );
         dateString->Append( theDate.Year.ToString()->Substring( 2 ) );
         formatting->Value = dateString->ToString();
         formatting->FormattingApplied = true;
      }
      catch ( Exception^ /*notInDateFormat*/ ) 
      {
         // Set to false in case there are other handlers interested trying to
         // format this DataGridViewCellFormattingEventArgs instance.
         formatting->FormattingApplied = false;
      }

   }
}
private void dataGridView1_CellFormatting(object sender, DataGridViewCellFormattingEventArgs e)
{
    // If the column is the Artist column, check the
    // value.
    if (this.dataGridView1.Columns[e.ColumnIndex].Name == "Artist")
    {
        if (e.Value != null)
        {
            // Check for the string "pink" in the cell.
            string stringValue = (string)e.Value;
            stringValue = stringValue.ToLower();
            if ((stringValue.IndexOf("pink") > -1))
            {
                e.CellStyle.BackColor = Color.Pink;
            }

        }
    }
    else if (this.dataGridView1.Columns[e.ColumnIndex].Name == "Release Date")
    {
        ShortFormDateFormat(e);
    }
}

//Even though the date internaly stores the year as YYYY, using formatting, the
//UI can have the format in YY.  
private static void ShortFormDateFormat(DataGridViewCellFormattingEventArgs formatting)
{
    if (formatting.Value != null)
    {
        try
        {
            System.Text.StringBuilder dateString = new System.Text.StringBuilder();
            DateTime theDate = DateTime.Parse(formatting.Value.ToString());

            dateString.Append(theDate.Month);
            dateString.Append("/");
            dateString.Append(theDate.Day);
            dateString.Append("/");
            dateString.Append(theDate.Year.ToString().Substring(2));
            formatting.Value = dateString.ToString();
            formatting.FormattingApplied = true;
        }
        catch (FormatException)
        {
            // Set to false in case there are other handlers interested trying to
            // format this DataGridViewCellFormattingEventArgs instance.
            formatting.FormattingApplied = false;
        }
    }
}
Private Sub dataGridView1_CellFormatting(ByVal sender As Object, _
    ByVal e As DataGridViewCellFormattingEventArgs) _
    Handles dataGridView1.CellFormatting
    ' If the column is the Artist column, check the
    ' value.
    If Me.dataGridView1.Columns(e.ColumnIndex).Name _
        = "Artist" Then
        If e.Value IsNot Nothing Then

            ' Check for the string "pink" in the cell.
            Dim stringValue As String = _
            CType(e.Value, String)
            stringValue = stringValue.ToLower()
            If ((stringValue.IndexOf("pink") > -1)) Then
                e.CellStyle.BackColor = Color.Pink
            End If

        End If
    ElseIf Me.dataGridView1.Columns(e.ColumnIndex).Name _
        = "Release Date" Then
        ShortFormDateFormat(e)
    End If
End Sub

'Even though the date internaly stores the year as YYYY, using formatting, the
'UI can have the format in YY.  
Private Shared Sub ShortFormDateFormat(ByVal formatting As DataGridViewCellFormattingEventArgs)
    If formatting.Value IsNot Nothing Then
        Try
            Dim dateString As System.Text.StringBuilder = New System.Text.StringBuilder()
            Dim theDate As Date = DateTime.Parse(formatting.Value.ToString())

            dateString.Append(theDate.Month)
            dateString.Append("/")
            dateString.Append(theDate.Day)
            dateString.Append("/")
            dateString.Append(theDate.Year.ToString().Substring(2))
            formatting.Value = dateString.ToString()
            formatting.FormattingApplied = True
        Catch notInDateFormat As FormatException
            ' Set to false in case there are other handlers interested trying to
            ' format this DataGridViewCellFormattingEventArgs instance.
            formatting.FormattingApplied = False
        End Try
    End If
End Sub

Comentarios

De forma predeterminada, el control DataGridView intentará convertir el valor de una celda en un formato adecuado para su presentación.By default, the DataGridView control will attempt to convert a cell's value into a format suitable for display. Por ejemplo, conseguirá convertir un valor numérico en una cadena para su presentación en una celda de cuadro de texto.For example, it will convert a numerical value into a string for display in a text box cell. Puede indicar la Convención de formato que se va a utilizar estableciendo la propiedad Format del DataGridViewCellStyle devuelta por propiedades como la propiedad DefaultCellStyle.You can indicate the formatting convention to use by setting the Format property of the DataGridViewCellStyle returned by properties such as the DefaultCellStyle property.

Si el formato estándar es insuficiente, puede personalizar el formato controlando el evento CellFormatting.If the standard formatting is insufficient, you can customize the formatting by handling the CellFormatting event. Este evento permite indicar el valor de presentación exacto, así como los estilos de celda, como el color de fondo y de primer plano, que se usarán para la presentación de la celda.This event lets you indicate the exact display value as well as the cell styles, such as background and foreground color, to use for the cell display. Esto significa que puede controlar este evento para cualquier tipo de formato de celda, con independencia de si el propio valor de la celda necesita formato.This means you can handle this event for any kind of cell formatting, regardless of whether the cell value itself needs formatting.

El evento CellFormatting se produce cada vez que se pinta cada celda, por lo que debe evitar un procesamiento largo al controlar este evento.The CellFormatting event occurs every time each cell is painted, so you should avoid lengthy processing when handling this event. Este evento también se produce cuando se recupera la celda FormattedValue o se llama a su método GetFormattedValue.This event also occurs when the cell FormattedValue is retrieved or its GetFormattedValue method is called.

Al controlar el evento CellFormatting, la propiedad ConvertEventArgs.Value se inicializa con el valor de la celda.When you handle the CellFormatting event, the ConvertEventArgs.Value property is initialized with the cell value. Si proporciona la conversión personalizada del valor de la celda al valor para mostrar, establezca la propiedad ConvertEventArgs.Value en el valor convertido, asegurándose de que el nuevo valor es del tipo especificado por la propiedad de la celda FormattedValueType.If you provide custom conversion from the cell value to the display value, set the ConvertEventArgs.Value property to the converted value, ensuring that the new value is of the type specified by the cell FormattedValueType property. Para indicar que no es necesario ningún formato de valor adicional, establezca la propiedad DataGridViewCellFormattingEventArgs.FormattingApplied en true.To indicate that no further value formatting is necessary, set the DataGridViewCellFormattingEventArgs.FormattingApplied property to true.

Cuando el controlador de eventos se completa, si el ConvertEventArgs.Value es null o no es del tipo correcto, o la propiedad DataGridViewCellFormattingEventArgs.FormattingApplied es false, se da formato a Value con las propiedades Format, NullValue, DataSourceNullValue y FormatProvider del estilo de celda devuelto por el DataGridViewCellFormattingEventArgs.CellStyle propiedad, que se inicializa con la celda 0.When the event handler completes, if the ConvertEventArgs.Value is null or is not of the correct type, or the DataGridViewCellFormattingEventArgs.FormattingApplied property is false, the Value is formatted using the Format, NullValue, DataSourceNullValue, and FormatProvider properties of the cell style returned by the DataGridViewCellFormattingEventArgs.CellStyle property, which is initialized using the cell InheritedStyle property.

Independientemente del valor de la propiedad DataGridViewCellFormattingEventArgs.FormattingApplied, se usan las propiedades de presentación del objeto devuelto por la propiedad DataGridViewCellFormattingEventArgs.CellStyle para representar la celda.Regardless of the value of the DataGridViewCellFormattingEventArgs.FormattingApplied property, the display properties of the object returned by the DataGridViewCellFormattingEventArgs.CellStyle property are used to render the cell.

Para obtener más información sobre el formato personalizado mediante el evento CellFormatting, consulte [How para: Personalizar el formato de los datos en el control DataGridView Windows Forms @ no__t-0.For more information about custom formatting using the CellFormatting event, see How to: Customize Data Formatting in the Windows Forms DataGridView Control.

Para evitar penalizaciones de rendimiento al controlar este evento, acceda a la celda a través de los parámetros del controlador de eventos en lugar de tener acceso directamente a la celda.To avoid performance penalties when handling this event, access the cell through the parameters of the event handler rather than accessing the cell directly.

Para personalizar la conversión de un valor con formato especificado por el usuario en un valor de celda real, controle el evento CellParsing.To customize the conversion of a formatted, user-specified value into an actual cell value, handle the CellParsing event.

Para obtener más información acerca de cómo controlar eventos, vea controlar y provocar eventos.For more information about how to handle events, see Handling and Raising Events.

Se aplica a

Consulte también: