DataGridViewCellFormattingEventArgs DataGridViewCellFormattingEventArgs DataGridViewCellFormattingEventArgs DataGridViewCellFormattingEventArgs Class

定义

DataGridViewCellFormatting 事件提供数据。Provides data for the CellFormatting event of a DataGridView.

public ref class DataGridViewCellFormattingEventArgs : System::Windows::Forms::ConvertEventArgs
public class DataGridViewCellFormattingEventArgs : System.Windows.Forms.ConvertEventArgs
type DataGridViewCellFormattingEventArgs = class
    inherit ConvertEventArgs
Public Class DataGridViewCellFormattingEventArgs
Inherits ConvertEventArgs
继承
DataGridViewCellFormattingEventArgsDataGridViewCellFormattingEventArgsDataGridViewCellFormattingEventArgsDataGridViewCellFormattingEventArgs

示例

下面的代码示例演示如何处理CellFormattingThe following code example demonstrates how to handle CellFormatting.

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

注解

处理CellFormatting事件以自定义的格式适用于显示单元值的转换或自定义根据其状态或值的单元格的外观。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.

CellFormatting每次每个单元格绘制,因此,应避免耗时处理在处理此事件时发生的事件。The CellFormatting event occurs every time each cell is painted, so you should avoid lengthy processing when handling this event. 也会发生此事件时该单元格FormattedValue检索或其GetFormattedValue调用方法。This event also occurs when the cell FormattedValue is retrieved or its GetFormattedValue method is called.

当处理CellFormatting事件,ConvertEventArgs.Value与单元格的值初始化属性。When you handle the CellFormatting event, the ConvertEventArgs.Value property is initialized with the cell value. 如果提供从单元格的值的显示值的自定义转换,设置ConvertEventArgs.Value属性设置为转换后的值,确保新的值指定单元格的类型的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. 若要指示没有更多值的格式设置是有必要,设置DataGridViewCellFormattingEventArgs.FormattingApplied属性设置为trueTo indicate that no further value formatting is necessary, set the DataGridViewCellFormattingEventArgs.FormattingApplied property to true.

事件处理程序完成后,如果ConvertEventArgs.Valuenull或者不是正确的类型,或DataGridViewCellFormattingEventArgs.FormattingApplied属性是false,则Value使用格式化FormatNullValueDataSourceNullValue,和FormatProvider属性返回的单元格样式DataGridViewCellFormattingEventArgs.CellStyle属性,则使用该单元格初始化InheritedStyle属性。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.

而不考虑的值DataGridViewCellFormattingEventArgs.FormattingApplied属性中,返回的对象的显示属性DataGridViewCellFormattingEventArgs.CellStyle属性用于呈现该单元格。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.

有关自定义格式设置使用的详细信息CellFormatting事件,请参阅如何:自定义 Windows 窗体 DataGridView 控件中的数据格式设置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.

若要自定义一个带格式的用户指定值转换为实际的单元值,请处理CellParsing事件。To customize the conversion of a formatted, user-specified value into an actual cell value, handle the CellParsing event.

有关如何处理事件的详细信息,请参阅处理和引发事件For more information about how to handle events, see Handling and Raising Events.

构造函数

DataGridViewCellFormattingEventArgs(Int32, Int32, Object, Type, DataGridViewCellStyle) DataGridViewCellFormattingEventArgs(Int32, Int32, Object, Type, DataGridViewCellStyle) DataGridViewCellFormattingEventArgs(Int32, Int32, Object, Type, DataGridViewCellStyle) DataGridViewCellFormattingEventArgs(Int32, Int32, Object, Type, DataGridViewCellStyle)

初始化 DataGridViewCellFormattingEventArgs 类的新实例。Initializes a new instance of the DataGridViewCellFormattingEventArgs class.

属性

CellStyle CellStyle CellStyle CellStyle

获取或设置正在格式化的单元格的样式。Gets or sets the style of the cell that is being formatted.

ColumnIndex ColumnIndex ColumnIndex ColumnIndex

获取正在格式化的单元格的列索引。Gets the column index of the cell that is being formatted.

DesiredType DesiredType DesiredType DesiredType

获取所需值的数据类型。Gets the data type of the desired value.

(Inherited from ConvertEventArgs)
FormattingApplied FormattingApplied FormattingApplied FormattingApplied

获取或设置一个值,该值指示单元格值是否已成功格式化。Gets or sets a value indicating whether the cell value has been successfully formatted.

RowIndex RowIndex RowIndex RowIndex

获取正在格式化的单元格的行索引。Gets the row index of the cell that is being formatted.

Value Value Value Value

获取或设置 ConvertEventArgs 的值。Gets or sets the value of the ConvertEventArgs.

(Inherited from ConvertEventArgs)

方法

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

确定指定的对象是否等于当前对象。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

作为默认哈希函数。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

获取当前实例的 TypeGets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

创建当前 Object 的浅表副本。Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

返回表示当前对象的字符串。Returns a string that represents the current object.

(Inherited from Object)

适用于

另请参阅