次の方法で共有

方法: Windows フォーム DataGridView コントロールのセルと列の動作と外観を拡張してカスタマイズする

DataGridView コントロールには、プロパティ、イベント、コンパニオン クラスを使用して外観と動作をカスタマイズするさまざまな方法が用意されています。 場合によっては、これらの機能が提供できる範囲を超えるセルの要件が存在する場合があります。 独自のカスタム DataGridViewCell クラスを作成して、拡張機能を提供できます。

カスタム DataGridViewCell クラスを作成する場合は、 DataGridViewCell 基底クラスまたはその派生クラスの 1 つから派生します。 任意の種類の列に任意の種類のセルを表示できますが、通常は、セルの種類の表示に特化したカスタム DataGridViewColumn クラスも作成します。 列クラスは、 DataGridViewColumn またはその派生型のいずれかから派生します。

次のコード例では、 DataGridViewRolloverCell という名前のカスタム セル クラスを作成します。このクラスは、マウスがセルの境界に入って離れるタイミングを検出します。 マウスがセルの境界内にある間は、インセット四角形が描画されます。 この新しい型は DataGridViewTextBoxCell から派生し、その基底クラスとして他のすべての点で動作します。 コンパニオン列クラスは、 DataGridViewRolloverColumnと呼ばれます。

これらのクラスを使用するには、DataGridView コントロールを含むフォームを作成し、DataGridViewRolloverColumn コレクションに 1 つ以上のColumns オブジェクトを追加し、コントロールに値を含む行を設定します。

注

この例は、空の行を追加すると正しく機能しません。 たとえば、 RowCount プロパティを設定してコントロールに行を追加すると、空の行が作成されます。 これは、この場合に追加された行が自動的に共有されるためです。つまり、 DataGridViewRolloverCell オブジェクトは個々のセルをクリックするまでインスタンス化されないため、関連付けられている行が共有解除されます。

この種類のセルのカスタマイズには共有されていない行が必要であるため、大規模なデータ セットでの使用には適していません。 行共有の詳細については、「 Windows フォーム DataGridView コントロールのスケーリングのベスト プラクティス」を参照してください。

注

DataGridViewCell または DataGridViewColumn から派生し、派生クラスに新しいプロパティを追加する場合は、Clone メソッドをオーバーライドして複製操作中に新しいプロパティをコピーしてください。 基底クラスのプロパティが新しいセルまたは列にコピーされるように、基底クラスの Clone メソッドも呼び出す必要があります。

DataGridView コントロールのセルと列をカスタマイズするには

  1. DataGridViewRolloverCell型から、DataGridViewTextBoxCellと呼ばれる新しいセル クラスを派生させます。

    public class DataGridViewRolloverCell : DataGridViewTextBoxCell
{

    Public Class DataGridViewRolloverCell
    Inherits DataGridViewTextBoxCell

    }

    End Class

  2. Paint クラスのDataGridViewRolloverCell メソッドをオーバーライドします。 オーバーライドでは、最初に、ホストされているテキスト ボックス機能を処理する基底クラスの実装を呼び出します。 次に、コントロールの PointToClient メソッドを使用して、カーソル位置 (画面座標) を DataGridView クライアント領域の座標に変換します。 マウス座標がセルの境界内にある場合は、インセット四角形を描画します。

    protected override void Paint(
    Graphics graphics,
    Rectangle clipBounds,
    Rectangle cellBounds,
    int rowIndex,
    DataGridViewElementStates cellState,
    object value,
    object formattedValue,
    string errorText,
    DataGridViewCellStyle cellStyle,
    DataGridViewAdvancedBorderStyle advancedBorderStyle,
    DataGridViewPaintParts paintParts)
{
    // Call the base class method to paint the default cell appearance.
    base.Paint(graphics, clipBounds, cellBounds, rowIndex, cellState,
        value, formattedValue, errorText, cellStyle,
        advancedBorderStyle, paintParts);

    // Retrieve the client location of the mouse pointer.
    Point cursorPosition =
        this.DataGridView.PointToClient(Cursor.Position);

    // If the mouse pointer is over the current cell, draw a custom border.
    if (cellBounds.Contains(cursorPosition))
    {
        Rectangle newRect = new Rectangle(cellBounds.X + 1,
            cellBounds.Y + 1, cellBounds.Width - 4,
            cellBounds.Height - 4);
        graphics.DrawRectangle(Pens.Red, newRect);
    }
}

    Protected Overrides Sub Paint( _
    ByVal graphics As Graphics, _
    ByVal clipBounds As Rectangle, _
    ByVal cellBounds As Rectangle, _
    ByVal rowIndex As Integer, _
    ByVal elementState As DataGridViewElementStates, _
    ByVal value As Object, _
    ByVal formattedValue As Object, _
    ByVal errorText As String, _
    ByVal cellStyle As DataGridViewCellStyle, _
    ByVal advancedBorderStyle As DataGridViewAdvancedBorderStyle, _
    ByVal paintParts As DataGridViewPaintParts)

    ' Call the base class method to paint the default cell appearance.
    MyBase.Paint(graphics, clipBounds, cellBounds, rowIndex, elementState, _
        value, formattedValue, errorText, cellStyle, _
        advancedBorderStyle, paintParts)

    ' Retrieve the client location of the mouse pointer.
    Dim cursorPosition As Point = _
        Me.DataGridView.PointToClient(Cursor.Position)

    ' If the mouse pointer is over the current cell, draw a custom border.
    If cellBounds.Contains(cursorPosition) Then
        Dim newRect As New Rectangle(cellBounds.X + 1, _
            cellBounds.Y + 1, cellBounds.Width - 4, _
            cellBounds.Height - 4)
        graphics.DrawRectangle(Pens.Red, newRect)
    End If

End Sub

  3. OnMouseEnter クラスのOnMouseLeaveメソッドとDataGridViewRolloverCell メソッドをオーバーライドして、マウス ポインターが入ったり離れたりしたときにセルを強制的に再描画します。

    // Force the cell to repaint itself when the mouse pointer enters it.
protected override void OnMouseEnter(int rowIndex)
{
    this.DataGridView.InvalidateCell(this);
}

// Force the cell to repaint itself when the mouse pointer leaves it.
protected override void OnMouseLeave(int rowIndex)
{
    this.DataGridView.InvalidateCell(this);
}

    ' Force the cell to repaint itself when the mouse pointer enters it.
Protected Overrides Sub OnMouseEnter(ByVal rowIndex As Integer)
    Me.DataGridView.InvalidateCell(Me)
End Sub

' Force the cell to repaint itself when the mouse pointer leaves it.
Protected Overrides Sub OnMouseLeave(ByVal rowIndex As Integer)
    Me.DataGridView.InvalidateCell(Me)
End Sub

  4. DataGridViewRolloverCellColumn型から、DataGridViewColumn と呼ばれる新しいクラスを派生させます。 コンストラクターで、新しい DataGridViewRolloverCell オブジェクトをその CellTemplate プロパティに割り当てます。

    public class DataGridViewRolloverCellColumn : DataGridViewColumn
{
    public DataGridViewRolloverCellColumn()
    {
        this.CellTemplate = new DataGridViewRolloverCell();
    }
}

    Public Class DataGridViewRolloverCellColumn
    Inherits DataGridViewColumn

    Public Sub New()
        Me.CellTemplate = New DataGridViewRolloverCell()
    End Sub

End Class

例

完全なコード例には、カスタム セル型の動作を示す小さなテスト フォームが含まれています。

using System;
using System.Drawing;
using System.Windows.Forms;

class Form1 : Form
{
    [STAThreadAttribute()]
    public static void Main()
    {
        Application.Run(new Form1());
    }

    public Form1()
    {
        DataGridView dataGridView1 = new DataGridView();
        DataGridViewRolloverCellColumn col =
            new DataGridViewRolloverCellColumn();
        dataGridView1.Columns.Add(col);
        dataGridView1.Rows.Add(new string[] { "" });
        dataGridView1.Rows.Add(new string[] { "" });
        dataGridView1.Rows.Add(new string[] { "" });
        dataGridView1.Rows.Add(new string[] { "" });
        this.Controls.Add(dataGridView1);
        this.Text = "DataGridView rollover-cell demo";
    }
}

public class DataGridViewRolloverCell : DataGridViewTextBoxCell
{
    protected override void Paint(
        Graphics graphics,
        Rectangle clipBounds,
        Rectangle cellBounds,
        int rowIndex,
        DataGridViewElementStates cellState,
        object value,
        object formattedValue,
        string errorText,
        DataGridViewCellStyle cellStyle,
        DataGridViewAdvancedBorderStyle advancedBorderStyle,
        DataGridViewPaintParts paintParts)
    {
        // Call the base class method to paint the default cell appearance.
        base.Paint(graphics, clipBounds, cellBounds, rowIndex, cellState,
            value, formattedValue, errorText, cellStyle,
            advancedBorderStyle, paintParts);

        // Retrieve the client location of the mouse pointer.
        Point cursorPosition =
            this.DataGridView.PointToClient(Cursor.Position);

        // If the mouse pointer is over the current cell, draw a custom border.
        if (cellBounds.Contains(cursorPosition))
        {
            Rectangle newRect = new Rectangle(cellBounds.X + 1,
                cellBounds.Y + 1, cellBounds.Width - 4,
                cellBounds.Height - 4);
            graphics.DrawRectangle(Pens.Red, newRect);
        }
    }

    // Force the cell to repaint itself when the mouse pointer enters it.
    protected override void OnMouseEnter(int rowIndex)
    {
        this.DataGridView.InvalidateCell(this);
    }

    // Force the cell to repaint itself when the mouse pointer leaves it.
    protected override void OnMouseLeave(int rowIndex)
    {
        this.DataGridView.InvalidateCell(this);
    }

}

public class DataGridViewRolloverCellColumn : DataGridViewColumn
{
    public DataGridViewRolloverCellColumn()
    {
        this.CellTemplate = new DataGridViewRolloverCell();
    }
}

Imports System.Drawing
Imports System.Windows.Forms

Class Form1
    Inherits Form

    <STAThreadAttribute()> _
    Public Shared Sub Main()
        Application.Run(New Form1())
    End Sub

    Public Sub New()
        Dim dataGridView1 As New DataGridView()
        Dim col As New DataGridViewRolloverCellColumn()
        dataGridView1.Columns.Add(col)
        dataGridView1.Rows.Add(New String() {""})
        dataGridView1.Rows.Add(New String() {""})
        dataGridView1.Rows.Add(New String() {""})
        dataGridView1.Rows.Add(New String() {""})
        Me.Controls.Add(dataGridView1)
        Me.Text = "DataGridView rollover-cell demo"
    End Sub

End Class

Public Class DataGridViewRolloverCell
    Inherits DataGridViewTextBoxCell

    Protected Overrides Sub Paint( _
        ByVal graphics As Graphics, _
        ByVal clipBounds As Rectangle, _
        ByVal cellBounds As Rectangle, _
        ByVal rowIndex As Integer, _
        ByVal elementState As DataGridViewElementStates, _
        ByVal value As Object, _
        ByVal formattedValue As Object, _
        ByVal errorText As String, _
        ByVal cellStyle As DataGridViewCellStyle, _
        ByVal advancedBorderStyle As DataGridViewAdvancedBorderStyle, _
        ByVal paintParts As DataGridViewPaintParts)

        ' Call the base class method to paint the default cell appearance.
        MyBase.Paint(graphics, clipBounds, cellBounds, rowIndex, elementState, _
            value, formattedValue, errorText, cellStyle, _
            advancedBorderStyle, paintParts)

        ' Retrieve the client location of the mouse pointer.
        Dim cursorPosition As Point = _
            Me.DataGridView.PointToClient(Cursor.Position)

        ' If the mouse pointer is over the current cell, draw a custom border.
        If cellBounds.Contains(cursorPosition) Then
            Dim newRect As New Rectangle(cellBounds.X + 1, _
                cellBounds.Y + 1, cellBounds.Width - 4, _
                cellBounds.Height - 4)
            graphics.DrawRectangle(Pens.Red, newRect)
        End If

    End Sub

    ' Force the cell to repaint itself when the mouse pointer enters it.
    Protected Overrides Sub OnMouseEnter(ByVal rowIndex As Integer)
        Me.DataGridView.InvalidateCell(Me)
    End Sub

    ' Force the cell to repaint itself when the mouse pointer leaves it.
    Protected Overrides Sub OnMouseLeave(ByVal rowIndex As Integer)
        Me.DataGridView.InvalidateCell(Me)
    End Sub

End Class

Public Class DataGridViewRolloverCellColumn
    Inherits DataGridViewColumn

    Public Sub New()
        Me.CellTemplate = New DataGridViewRolloverCell()
    End Sub

End Class

コードのコンパイル

この例では、次のものが必要です。

  • System、System.Windows.Forms、および System.Drawing アセンブリへの参照。

こちらも参照ください