CustomDrawRowHeaderIndentEventArgs.CategoryIndents Property

Gets a collection of category indents to be painted.

Namespace: DevExpress.XtraVerticalGrid.Events

Assembly: DevExpress.XtraVerticalGrid.v19.1.dll

Declaration

C#

public Indents CategoryIndents { get; }

VB.NET

Public ReadOnly Property CategoryIndents As Indents

Property Value

Type	Description
DevExpress.XtraVerticalGrid.ViewInfo.Indents	An Indents object representing the collection of painted category indents.

Remarks

Each row header within a vertical grid contains indents. Indents are used to represent the data within the control in a tree like stucture. Indents are subdivided into two types (see the image below):

• row indents which belong to editor or multi-editor rows;
• category indents which belong only to category rows.

The CategoryIndents property provides access to the collection of category indents to be painted. Individual indents can be accessed using index notation.

Example

The following sample code handles the VGridControlBase.CustomDrawRowHeaderCell and VGridControlBase.CustomDrawRowHeaderIndent events to custom paint the focused row header and its indents. If the focused row is a category row, it is painted in the default manner.

The image below shows the result.

C#

using System.Drawing.Drawing2D;
using DevExpress.XtraVerticalGrid.ViewInfo;
using DevExpress.XtraVerticalGrid.Events;

private void vGridControl1_CustomDrawRowHeaderCell(object sender, 
CustomDrawRowHeaderCellEventArgs e) {
    if (e.Row.XtraRowTypeID != 0 && e.Focused){
        // Creates the brush which is used to fill the background of row headers.
        Brush backBrush;
        backBrush = new LinearGradientBrush(e.Bounds, Color.Orange, 
          e.Appearance.BackColor2, LinearGradientMode.Vertical);
        e.Graphics.FillRectangle(backBrush, e.Bounds);
        // Paints the row header's caption.
        e.Graphics.DrawString(e.Caption, e.Appearance.Font, new SolidBrush(Color.DarkBlue), 
          e.CaptionRect, e.Appearance.GetStringFormat());
        // Paints the row header's image.
        e.Graphics.DrawImage(imageList1.Images[0], e.ImageRect);
        e.Handled = true;
    }
}

private void vGridControl1_CustomDrawRowHeaderIndent(object sender, 
CustomDrawRowHeaderIndentEventArgs e) {
    if (e.Row.XtraRowTypeID == 0)
        return;
    if (e.Row == vGridControl1.FocusedRow){
        // Creates the brush which is used to fill the background of row indents.
        Brush backBrush;
        backBrush = new LinearGradientBrush(e.Bounds, Color.Orange, 
          e.Appearance.BackColor2, LinearGradientMode.Vertical);
        // Fills the category indent's background.
        foreach (IndentInfo indInfo in e.CategoryIndents)
            e.Graphics.FillRectangle(new LinearGradientBrush(indInfo.Bounds, 
              indInfo.Style.BackColor, indInfo.Style.BackColor, 
              LinearGradientMode.Vertical), indInfo.Bounds);
        // Fills the row indent's background.
        if (e.RowIndents.Count - 1 > -1){
            for (int i = 0; i < e.RowIndents.Count - 1; i++)
                e.Graphics.FillRectangle(new LinearGradientBrush(e.RowIndents[i].Bounds, 
                  e.RowIndents[i].Style.BackColor, e.RowIndents[i].Style.BackColor2, 
                  LinearGradientMode.Vertical), e.RowIndents[i].Bounds);
            e.Graphics.FillRectangle(backBrush, e.RowIndents[e.RowIndents.Count - 1].Bounds);
        }

        e.Handled = true;
    }
}

VB.NET

Imports System.Drawing.Drawing2D
Imports DevExpress.XtraVerticalGrid.ViewInfo
Imports DevExpress.XtraVerticalGrid.Events

Private Sub VGridControl1_CustomDrawRowHeaderCell(ByVal sender As Object, _
ByVal e As CustomDrawRowHeaderCellEventArgs) Handles VGridControl1.CustomDrawRowHeaderCell
   If Not e.Row.XtraRowTypeID = 0 And e.Focused Then
      ' Creates the brush which is used to fill the background of row headers.
      Dim backBrush As Brush
      backBrush = New LinearGradientBrush(e.Bounds, Color.Orange, _
        e.Appearance.BackColor2, LinearGradientMode.Vertical)
      e.Graphics.FillRectangle(backBrush, e.Bounds)
      ' Paints the captions of row headers.
      Dim CaptionRect As RectangleF = New RectangleF(e.CaptionRect.X, _
        e.CaptionRect.Y, e.CaptionRect.Width, e.CaptionRect.Height)
      e.Graphics.DrawString(e.Caption, e.Appearance.Font, _
         New SolidBrush(Color.DarkBlue), CaptionRect, e.Appearance.GetStringFormat())
      ' Paints the row header's image.
      e.Graphics.DrawImage(imageList1.Images(0), e.ImageRect)
      e.Handled = True
   End If
End Sub

Private Sub VGridControl1_CustomDrawRowHeaderIndent(ByVal sender As Object, _
ByVal e As CustomDrawRowHeaderIndentEventArgs) _
Handles VGridControl1.CustomDrawRowHeaderIndent
   If e.Row.XtraRowTypeID = 0 Then
      Return
   End If
   If e.Row Is VGridControl1.FocusedRow Then
      ' Creates the brush which is used to fill the background of row indents.
      Dim backBrush As Brush
      backBrush = New LinearGradientBrush(e.Bounds, Color.Orange, _
        e.Appearance.BackColor2, LinearGradientMode.Vertical)
      ' Fills the category indent's background.
      Dim indInfo As IndentInfo
      For Each indInfo In e.CategoryIndents
         e.Graphics.FillRectangle(New LinearGradientBrush(indInfo.Bounds, _
           indInfo.Style.BackColor, indInfo.Style.BackColor, LinearGradientMode.Vertical), _
           indInfo.Bounds)
      Next indInfo
      ' Fills the row indent's background.
      Dim i As Integer
      If e.RowIndents.Count - 1 > -1 Then
         For i = 0 To e.RowIndents.Count - 2
            e.Graphics.FillRectangle(New LinearGradientBrush(e.RowIndents(i).Bounds, _
              e.RowIndents(i).Style.BackColor, e.RowIndents(i).Style.BackColor2, _
              LinearGradientMode.Vertical), e.RowIndents(i).Bounds)
         Next i
         e.Graphics.FillRectangle(backBrush, e.RowIndents(e.RowIndents.Count - 1).Bounds)
      End If

      e.Handled = True
   End If
End Sub