TreeList.CustomDrawNodeCell Event

Provides the ability to perform custom painting of node cells.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v19.2.dll

Declaration

C#

[DXCategory("CustomDraw")]
public event CustomDrawNodeCellEventHandler CustomDrawNodeCell

VB.NET

<DXCategory("CustomDraw")>
Public Event CustomDrawNodeCell As CustomDrawNodeCellEventHandler

Event Data

The CustomDrawNodeCell event's data class is CustomDrawNodeCellEventArgs. The following properties provide information specific to this event:

Property	Description
Appearance	Gets the painted element’s appearance settings. Inherited from CustomDrawEventArgs.
Bounds	Gets the painted element’s bounding rectangle. Inherited from CustomDrawEventArgs.
Cache	Gets an object specifying the storage for the most used pens, fonts and brushes. Inherited from CustomDrawEventArgs.
CellText	Gets the painted cell’s display text.
CellValue	Gets the painted cell’s value.
Column	Gets the painted cell’s column.
EditPainter	Gets the editor’s painter object used to paint a cell.
EditViewInfo	Gets the editor’s view information.
Focused	Gets a value indicating whether the painted cell has focus.
Graphics	Gets an object used to paint. Inherited from CustomDrawEventArgs.
Handled	Gets or sets a value specifying whether an event was handled and that the default element painting is therefore not required. Inherited from CustomDrawEventArgs.
IsRightToLeft	Gets a value indicating whether the TreeList’s elements are aligned to support locales using right-to-left fonts. Inherited from CustomDrawEventArgs.
ObjectArgs	Gets an object containing information about the painted element. Inherited from CustomDrawEventArgs.
Painter	Gets the painter object that provides the default element’s painting mechanism. Inherited from CustomDrawEventArgs.

The event data class exposes the following methods:

Method	Description
DefaultDraw()	Performs default painting of an element. Inherited from CustomDrawEventArgs.

Remarks

The event parameter provides all the information necessary to paint a node cell. The Node and CustomDrawNodeCellEventArgs.Column parameter properties allow you to identify the node and column to which a cell belongs.

See the Custom Draw Scenarios topic for information on using custom draw events.

Note

Custom drawing of any kind is ignored when printing/exporting the XtraTreeList. If it’s necessary to dynamically change cell styles in the print/export output of the Tree List control, handle the TreeList.NodeCellStyle event.

Important

Never change cell values or modify the control’s layout on this event, or any other event designed to tune the control’s appearance. Any action that causes a layout update can cause the control to malfunction.

Example

The following sample code handles the TreeList.CustomDrawNodeCell event. It is used to perform custom painting of node cells. All node cells are painted in the same manner.

The image below illustrates the result of executing the sample code.

C#

using System.Drawing;
using System.Drawing.Drawing2D;
using DevExpress.XtraTreeList;

private void treeList1_CustomDrawNodeCell(object sender, CustomDrawNodeCellEventArgs e) {
    // Create brushes for cells.
    Brush backBrush, foreBrush;
    if (e.Node != (sender as TreeList).FocusedNode)
    {
        backBrush = e.Cache.GetGradientBrush(e.Bounds, Color.PapayaWhip, Color.PeachPuff, LinearGradientMode.ForwardDiagonal);
        foreBrush = Brushes.Black;
    }
    else
    {
        backBrush = Brushes.DarkBlue;
        foreBrush = e.Cache.GetSolidBrush(Color.PeachPuff);
    }
    // Fill the background.
    e.Cache.FillRectangle(backBrush, e.Bounds);
    // Paint the node value.
    e.Cache.DrawString(e.CellText, e.Appearance.Font, foreBrush, e.Bounds,
      e.Appearance.GetStringFormat());

    // Prohibit default painting.
    e.Handled = true;
}

VB.NET

Imports System.Drawing
Imports System.Drawing.Drawing2D
Imports DevExpress.XtraTreeList

Private Sub TreeList1_CustomDrawNodeCell(sender As Object, e As DevExpress.XtraTreeList.CustomDrawNodeCellEventArgs) Handles TreeList1.CustomDrawNodeCell
    ' Create brushes for cells.
    Dim BackBrush, ForeBrush As Brush
    If e.Node.Id <> sender.FocusedNode.Id Then
        BackBrush = e.Cache.GetGradientBrush(e.Bounds, Color.PapayaWhip,
                                             Color.PeachPuff, LinearGradientMode.ForwardDiagonal)
        ForeBrush = Brushes.Black
    Else
        BackBrush = Brushes.DarkBlue
        ForeBrush = Brushes.PeachPuff
    End If
    ' Fill the background.
    e.Cache.FillRectangle(BackBrush, e.Bounds)
    ' Paint the node value.
    e.Cache.DrawString(e.CellText, e.Appearance.Font, ForeBrush, e.Bounds,
                       e.Appearance.GetStringFormat())

    ' Prohibit default painting
    e.Handled = True
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CustomDrawNodeCell event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-add-a-find-panel-similar-to-the-one-provided-by-gridcontrol-to-treelist-e2877/CS/WindowsApplication3/FindPanel.cs#L64

tree.FilterNode += OnFilterNode;
tree.CustomDrawNodeCell += OnCustomDrawNodeCell;
CreateLayoutControl();

hot-tracking-nodes-similar-to-windows-7-style-e3802/CS/E3802/HotTrackHelper.cs#L31

fTreeList.CustomDrawNodeIndent += new CustomDrawNodeIndentEventHandler(Tree_CustomDrawNodeIndent);
fTreeList.CustomDrawNodeCell += new CustomDrawNodeCellEventHandler(Tree_CustomDrawNodeCell);
fTreeList.MouseMove += new System.Windows.Forms.MouseEventHandler(Tree_MouseMove);

how-to-highlight-the-next-or-previous-search-result-in-the-treelist-t368346/CS/WindowsFormsApplication2/FindHelper.cs#L89

if (treeList == null) return;
treeList.CustomDrawNodeCell -= treeList_CustomDrawNodeCell;
if(subscribe)

how-to-display-bands-and-columns-in-the-same-tree-list-in-the-customization-form-e3723/CS/CustomDescendants/TreeListBandedCustomizationForm.cs#L42

    Controls.Add(bandsColumnTreeList_);
    BandsColumnTreeList.CustomDrawNodeCell += new CustomDrawNodeCellEventHandler(BandsColumnTreeList_CustomDrawNodeCell);
}

how-to-implement-a-search-by-visible-nodes-in-treelist-e2728/CS/WindowsApplication1/MyTreeListSearchHelper.cs#L15

_TreeList = treeList;
_TreeList.CustomDrawNodeCell += _TreeList_CustomDrawNodeCell;
_TreeList.FocusedNodeChanged += new FocusedNodeChangedEventHandler(_TreeList_FocusedNodeChanged);

VB.NET

how-to-add-a-find-panel-similar-to-the-one-provided-by-gridcontrol-to-treelist-e2877/VB/WindowsApplication3/FindPanel.vb#L67

AddHandler tree.FilterNode, AddressOf OnFilterNode
AddHandler tree.CustomDrawNodeCell, AddressOf OnCustomDrawNodeCell
CreateLayoutControl()

hot-tracking-nodes-similar-to-windows-7-style-e3802/VB/E3802/HotTrackHelper.vb#L27

AddHandler fTreeList.CustomDrawNodeIndent, AddressOf Tree_CustomDrawNodeIndent
AddHandler fTreeList.CustomDrawNodeCell, AddressOf Tree_CustomDrawNodeCell
AddHandler fTreeList.MouseMove, AddressOf Tree_MouseMove

how-to-highlight-the-next-or-previous-search-result-in-the-treelist-t368346/VB/WindowsFormsApplication2/FindHelper.vb#L90

End If
RemoveHandler treeList.CustomDrawNodeCell, AddressOf treeList_CustomDrawNodeCell
If subscribe Then

how-to-display-bands-and-columns-in-the-same-tree-list-in-the-customization-form-e3723/VB/CustomDescendants/TreeListBandedCustomizationForm.vb#L47

    Controls.Add(bandsColumnTreeList_)
    AddHandler BandsColumnTreeList.CustomDrawNodeCell, AddressOf BandsColumnTreeList_CustomDrawNodeCell
End Sub

how-to-implement-a-search-by-visible-nodes-in-treelist-e2728/VB/WindowsApplication1/MyTreeListSearchHelper.vb#L13

_TreeList = treeList
AddHandler _TreeList.CustomDrawNodeCell, AddressOf _TreeList_CustomDrawNodeCell
AddHandler _TreeList.FocusedNodeChanged, AddressOf _TreeList_FocusedNodeChanged