TreeList.NodeCellStyle Event

Enables appearances to be assigned to individual cells.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v18.1.dll

Declaration

C#

[DXCategory("Appearance")]
public event GetCustomNodeCellStyleEventHandler NodeCellStyle

VB.NET

<DXCategory("Appearance")>
Public Event NodeCellStyle As GetCustomNodeCellStyleEventHandler

Event Data

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

Property	Description
Appearance	Gets the appearance settings used to paint the cell currently being processed.
Column	Gets a column to which the cell processed by an event belongs. Inherited from CellEventArgs.
Node	Gets the current Tree List node. Inherited from NodeEventArgs.

Remarks

The NodeCellStyle event is raised for individual cells before they need to be repainted. The processed cell is identified by the event parameter’s NodeEventArgs.Node and CellEventArgs.Column properties. To customize the appearance settings used to paint the cell use the GetCustomNodeCellStyleEventArgs.Appearance property.

If more complex cell painting needs to be performed, handle the TreeList.CustomDrawNodeCell event.

For more information on appearances, see the Appearances document.

Note

The control’s events designed to change the appearance or rendering of control elements must not be used to update cell values or to modify the control’s layout. Any inappropriate operation which causes a layout update, may break the normal control behavior.

Example

The following sample code handles the TreeList.NodeCellStyle event to modify the appearance of the “Budget” column’s cells whose values are greater than 500,000.

The image below shows the result.

C#

using DevExpress.XtraTreeList;

private void treeList1_NodeCellStyle(object sender, GetCustomNodeCellStyleEventArgs e) {
   // Modify the appearance settings used to paint the "Budget" column's cells
   // whose values are greater than 500,000.
   if (e.Column.FieldName != "Budget") return;
   if (Convert.ToInt32(e.Node.GetValue(e.Column.AbsoluteIndex)) > 500000) {
      e.Appearance.BackColor = Color.FromArgb(80, 255, 0, 255);
      e.Appearance.ForeColor = Color.White;
      e.Appearance.Font = new Font(e.Appearance.Font, FontStyle.Bold);
   }
}

VB.NET

Imports DevExpress.XtraTreeList

Private Sub TreeList1_NodeCellStyle(ByVal sender As Object, _
ByVal e As GetCustomNodeCellStyleEventArgs) Handles TreeList1.CustomNodeCellStyle
   ' Modify the appearance settings used to paint the "Budget" column's cells
   ' whose values are greater than 500,000.
   If e.Column.FieldValue <> "Budget" Exit Sub
   If Convert.ToInt32(e.Node.GetValue(BudgetColumnID)) > 500000 Then
      e.Appearance.BackColor = Color.FromArgb(80, 255, 0, 255)
      e.Appearance.ForeColor = Color.White
      e.Appearance.Font = New Font(e.Appearance.Font, FontStyle.Bold)
   End If
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the NodeCellStyle 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-highlight-a-target-node-during-the-drag-drop-operation-e2074/CS/WindowsApplication1/DnDHighlightHelper.cs#L33

if (SelectedTreeList == null) return;
SelectedTreeList.NodeCellStyle += TreeList_NodeCellStyle;
SelectedTreeList.DragOver += TreeList_DragOver;

how-to-implement-block-selection-for-treelist-cells-e2176/CS/BlockSelection/BlockSelector.cs#L31

    fList.MouseDown += new MouseEventHandler(fList_MouseDown);
    fList.NodeCellStyle += new GetCustomNodeCellStyleEventHandler(fList_NodeCellStyle);
}

VB.NET

how-to-highlight-a-target-node-during-the-drag-drop-operation-e2074/VB/WindowsApplication1/DnDHighlightHelper.vb#L42

End If
AddHandler SelectedTreeList.NodeCellStyle, AddressOf TreeList_NodeCellStyle
AddHandler SelectedTreeList.DragOver, AddressOf TreeList_DragOver

how-to-implement-block-selection-for-treelist-cells-e2176/VB/BlockSelection/BlockSelector.vb#L29

    AddHandler fList.MouseDown, AddressOf fList_MouseDown
    AddHandler fList.NodeCellStyle, AddressOf fList_NodeCellStyle
End Sub

how-to-implement-the-cells-multi-selection-feature-in-treelist-e2795/VB/WindowsApplication1/Helper/BlockSelector.vb#L32

AddHandler fList.MouseMove, AddressOf fList_MouseMove
AddHandler fList.NodeCellStyle, AddressOf fList_NodeCellStyle
AddHandler fList.BeforeExpand, AddressOf fList_BeforeExpand

how-to-implement-the-group-level-style-feature-in-the-treelist-e2368/VB/Q220534/Form1.vb#L58

Private Sub OnTreeListNodeCellStyle(ByVal sender As Object, ByVal e As GetCustomNodeCellStyleEventArgs) Handles treeList.NodeCellStyle
    If Not e.Node.HasChildren Then

how-to-implement-hot-tracking-in-the-xtratreelist-e766/VB/XtraTreeListHotTrack/Form1.vb#L39

Private Sub treeList1_NodeCellStyle(ByVal sender As Object, ByVal e As GetCustomNodeCellStyleEventArgs) Handles treeList1.NodeCellStyle
    If e.Node Is HotTrackNode Then