Практическое руководство. Настройка ячеек и столбцов в элементе управления DataGridView в Windows Forms путем расширения их поведения и внешнего вида

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

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

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

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

Замечание

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

Так как для этого типа настройки ячейки требуются не совместно используемые строки, оно не подходит для использования с большими наборами данных. Дополнительные сведения о совместном использовании строк см. в Лучшие практики по масштабированию элемента управления Windows Forms 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.

См. также

• DataGridView
• DataGridViewCell
• DataGridViewColumn
• Кастомизация элемента управления DataGridView в Windows Forms
• Архитектура элемента управления DataGridView
• Типы столбцов в элементе управления Windows Forms DataGridView
• Лучшие практики по масштабированию элемента управления DataGridView в Windows Forms