DataGridViewCellFormattingEventArgs クラス

定義

CellFormattingDataGridView イベントのデータを提供します。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プロパティを変換後の値に設定し、新しい値が cell 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適切な型ではない場合、またfalseFormatプロパティValueがの場合、はNullValueDataSourceNullValue、、およびを使用して書式設定されます。プロパティによって返されるセルスタイルのプロパティ。セルInheritedStyleプロパティを使用して初期化されます。 FormatProvider DataGridViewCellFormattingEventArgs.CellStyleWhen 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 クラスの新しいインスタンスを初期化します。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()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)

適用対象

こちらもご覧ください