GetStateImageEventArgs.NodeImageIndex Property

Gets or sets the index of the node’s image in a source image list. When handling the TreeList.GetStateImage event, the source of images is specified by the TreeList.StateImageList property. When handling the TreeList.GetSelectImage event, the source of images is specified by the TreeList.SelectImageList property.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v19.1.dll

Declaration

C#

public int NodeImageIndex { get; set; }

VB.NET

Public Property NodeImageIndex As Integer

Property Value

Type	Description
Int32	An integer value representing the zero-based index of an image from a source image list.

Remarks

The NodeImageIndex property specifies the image by its position within a source image list.

When handling the TreeList.GetStateImage event:

• The source list image is specified by the TreeList.StateImageList property.
• The initial value of the NodeImageIndex property is determined by the TreeListNode.StateImageIndex property.

When handling the TreeList.GetStateImage event:

• The source list image is specified by the TreeList.SelectImageList property.
• The initial value of the NodeImageIndex property is calculated according to the TreeList.ImageIndexFieldName, TreeListNode.SelectImageIndex and TreeListNode.ImageIndex properties.

Related GitHub Examples

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

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#

node-checking-using-state-images-e902/CS/NodeChecking.cs#L77

if(check == CheckState.Unchecked)
    e.NodeImageIndex = 0;
else if(check == CheckState.Checked)

how-to-dynamically-fill-tree-list-content-in-the-background-thread-e3750/CS/ExampleMainForm.cs#L80

{
    e.NodeImageIndex = e.Node.Id;
}

Reporting_winforms-eud-how-to-create-a-control-template-gallery-with-reusable-control-sets-t341218/CS/ControlTemplateGallerySample/ControlTemplateGallery/TemplateUserControl.cs#L123

private void OnGetStateImage(object sender, DevExpress.XtraTreeList.GetStateImageEventArgs e) {
    e.NodeImageIndex = e.Node.Level;
}

VB.NET

node-checking-using-state-images-e902/VB/NodeChecking.vb#L91

If check = CheckState.Unchecked Then
    e.NodeImageIndex = 0
ElseIf check = CheckState.Checked Then

how-to-dynamically-fill-tree-list-content-in-the-background-thread-e3750/VB/ExampleMainForm.vb#L69

If e.Node.Id < imageListForTree.Images.Count Then
    e.NodeImageIndex = e.Node.Id
Else

Reporting_winforms-eud-how-to-create-a-control-template-gallery-with-reusable-control-sets-t341218/VB/ControlTemplateGallerySample/ControlTemplateGallery/TemplateUserControl.vb#L131

Private Sub OnGetStateImage(ByVal sender As Object, ByVal e As DevExpress.XtraTreeList.GetStateImageEventArgs)
    e.NodeImageIndex = e.Node.Level
End Sub