DataGridViewCellFormattingEventArgs Класс

Определение

Предоставляет данные для события CellFormatting объекта DataGridView.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
Наследование
DataGridViewCellFormattingEventArgs

Примеры

В следующем примере кода показано, как выполнить обработку CellFormatting .The 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 свойству значение true .To indicate that no further value formatting is necessary, set the DataGridViewCellFormattingEventArgs.FormattingApplied property to true.

При завершении работы обработчика событий, если параметр ConvertEventArgs.Value имеет значение null или имеет неправильный тип или DataGridViewCellFormattingEventArgs.FormattingApplied свойство имеет значение false , то Value форматируется с использованием Format NullValue свойств,, DataSourceNullValue и FormatProvider стиля ячейки, возвращаемого DataGridViewCellFormattingEventArgs.CellStyle свойством, которое инициализируется с помощью InheritedStyle свойства Cell.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 Forms 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.Initializes a new instance of the DataGridViewCellFormattingEventArgs class.

Свойства

CellStyle

Получает или задает стиль форматируемой ячейки.Gets or sets the style of the cell that is being formatted.

ColumnIndex

Получает индекс столбца, содержащего форматируемую ячейку.Gets the column index of the cell that is being formatted.

DesiredType

Возвращает тип данных требуемого значения.Gets the data type of the desired value.

(Унаследовано от ConvertEventArgs)
FormattingApplied

Получает или задает значение, показывающее, было ли успешно отформатировано значение ячейки.Gets or sets a value indicating whether the cell value has been successfully formatted.

RowIndex

Получает индекс строки, содержащей форматируемую ячейку.Gets the row index of the cell that is being formatted.

Value

Возвращает или задает значение ConvertEventArgs.Gets or sets the value of the ConvertEventArgs.

(Унаследовано от ConvertEventArgs)

Методы

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Применяется к

См. также раздел