DataGridViewCellFormattingEventArgs Class
Collapse the table of content
Expand the table of content

DataGridViewCellFormattingEventArgs Class


Provides data for the CellFormatting event of a DataGridView.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)


public class DataGridViewCellFormattingEventArgs : ConvertEventArgs

System_CAPS_pubmethodDataGridViewCellFormattingEventArgs(Int32, Int32, Object, Type, DataGridViewCellStyle)

Initializes a new instance of the DataGridViewCellFormattingEventArgs class.


Gets or sets the style of the cell that is being formatted.


Gets the column index of the cell that is being formatted.


Gets the data type of the desired value.(Inherited from ConvertEventArgs.)


Gets or sets a value indicating whether the cell value has been successfully formatted.


Gets the row index of the cell that is being formatted.


Gets or sets the value of the ConvertEventArgs.(Inherited from ConvertEventArgs.)


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns a string that represents the current object.(Inherited from Object.)

Handle the CellFormatting event to customize the conversion of a cell value into a format suitable for display or to customize the appearance of a cell depending on its state or value.

The CellFormatting event occurs every time each cell is painted, so you should avoid lengthy processing when handling this event. This event also occurs when the cell FormattedValue is retrieved or its GetFormattedValue method is called.

When you handle the CellFormatting event, the ConvertEventArgs.Value property is initialized with the cell value. 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. To indicate that no further value formatting is necessary, set the DataGridViewCellFormattingEventArgs.FormattingApplied property to true.

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.

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.

For more information about custom formatting using the CellFormatting event, see How to: Customize Data Formatting in the Windows Forms DataGridView Control.

To avoid performance penalties when handling this event, access the cell through the parameters of the event handler rather than accessing the cell directly.

To customize the conversion of a formatted, user-specified value into an actual cell value, handle the CellParsing event.

For more information about handling events, see NIB: Consuming Events.

The following code example demonstrates how to handle CellFormatting.

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")

//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)
            System.Text.StringBuilder dateString = new System.Text.StringBuilder();
            DateTime theDate = DateTime.Parse(formatting.Value.ToString());

            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;

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
© 2015 Microsoft