DataGridView.CellFormatting DataGridView.CellFormatting DataGridView.CellFormatting DataGridView.CellFormatting Event

定義

セルの内容が、表示用に書式指定されなければならないときに発生します。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 

次のコード例を処理する方法を示しています、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

注釈

既定で、DataGridViewコントロールは、セルの値を表示に適した形式に変換しようとしています。By default, the DataGridView control will attempt to convert a cell's value into a format suitable for display. たとえば、数値をテキスト ボックスのセルに表示文字列に変換には。For example, it will convert a numerical value into a string for display in a text box cell. 設定して使用する書式設定規則を指定することができます、Formatのプロパティ、DataGridViewCellStyleなどのプロパティによって返される、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.

処理することによって書式設定をカスタマイズするには標準の書式設定ための十分な場合、CellFormattingイベント。If the standard formatting is insufficient, you can customize the formatting by handling the CellFormatting event. このイベントでは、完全な表示値と前景色および背景色、セルの表示に使用するなど、セルのスタイルを指定できます。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. つまり、任意の種類のセルのセルの値自体に書式設定が必要かどうかに関係なく、書式設定には、このイベントを処理することができます。This means you can handle this event for any kind of cell formatting, regardless of whether the cell value itself needs formatting.

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.Valuenullまたは正しい型ではない、またはDataGridViewCellFormattingEventArgs.FormattingAppliedプロパティはfalseValueを使用して書式設定、 FormatNullValueDataSourceNullValueFormatProviderによって返されるセル スタイルのプロパティ、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.

適用対象

こちらもご覧ください