Практическое руководство. Дополнительные возможности управления внешним видом и поведением ячеек и столбцов элемента управления DataGridView в Windows Forms

Статья
06/02/2023

Внешний вид и поведение элемента управления DataGridView можно настроить несколькими способами с помощью свойств, событий и классов-компаньонов. В ряде случаев к ячейкам могут предъявляться требования, когда этих возможностей будет недостаточно. Вы можете создать пользовательский класс DataGridViewCell для расширения функциональных возможностей.

Пользовательский класс DataGridViewCell создается как производный от базового класса DataGridViewCell или одного из его производных классов. Хотя любой тип ячейки можно отобразить в любом типе столбца, как правило, потребуется также создать пользовательский класс DataGridViewColumn, специально предназначенный для отображения пользовательского типа ячейки. Классы столбцов являются производными от DataGridViewColumn или от одного из его производных типов.

В примере кода ниже создается пользовательский класс ячейки с именем DataGridViewRolloverCell, который обнаруживает, когда указатель мыши пересекает границы ячейки. Когда указатель мыши находится внутри границ ячейки, рисуется внутренняя рамка. Этот новый тип является производным от DataGridViewTextBoxCell и во всем остальном ведет себя так же, как и базовый класс. Класс-компаньон столбца имеет имя DataGridViewRolloverColumn.

Для использования этих классов необходимо создать форму, содержащую элемент управления DataGridView, добавить один или несколько объектов DataGridViewRolloverColumn в коллекцию Columns и заполнить элемент управления строками со значениями.

Примечание.

Пример не будет работать правильно с пустыми строками. Пустые строки создаются, например, при добавлении строк в элемент управления путем задания свойства RowCount. Это происходит потому, что добавленные в этом случае строки автоматически становятся общими. Это означает, что экземпляры объектов DataGridViewRolloverCell не будут создаваться до тех пор, пока не будут нажаты отдельные ячейки, что отменяет блокирование связанных общих строк.

Так как подобная настройка ячеек требует, чтобы строки не были общими, она не подходит для использования с большими наборами данных. Дополнительные сведения о совместном использовании строк см. в статье Масштабирование элемента управления DataGridView в Windows Forms.

Примечание.

При наследовании от класса DataGridViewCell или DataGridViewColumn и добавлении новых свойств к производному классу необходимо переопределить метод Clone, чтобы скопировать новые свойства во время операций копирования. Кроме того, необходимо вызвать метод Clone базового класса, чтобы свойства базового класса скопировались в новую ячейку или столбец.

Настройка ячеек и столбцов в элементе управления DataGridView

Создайте класс ячейки с именем DataGridViewRolloverCell, производный от типа DataGridViewTextBoxCell.

public class DataGridViewRolloverCell : DataGridViewTextBoxCell
{

Public Class DataGridViewRolloverCell
    Inherits DataGridViewTextBoxCell

End Class

Переопределите метод 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

Переопределите методы 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

Создайте класс с именем 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.

Практическое руководство. Дополнительные возможности управления внешним видом и поведением ячеек и столбцов элемента управления DataGridView в Windows Forms

Настройка ячеек и столбцов в элементе управления DataGridView

Пример

Компиляция кода

См. также

Обратная связь

Дополнительные ресурсы