TreeListView.ImageFieldName Property

Gets or sets the name of the field in a data source that contains node images. This is a dependency property.

Assembly : DevExpress.Xpf.Grid.v25.2.dll

NuGet Package : DevExpress.Wpf.Grid.Core

Declaration

C#
VB.NET

csharp

public string ImageFieldName { get; set; }

Public Property ImageFieldName As String

Property Value

Type	Description
String

A String value that specifies the field name.

Remarks

Set the TreeListView.ShowNodeImages property to true to display node images. The GridControl gets these images from the data source field of the byte[] or ImageSource type. To specify the field name, use the ImageFieldName property.

XAML

xaml

<dxg:GridControl ItemsSource="{Binding Employees}">
    <dxg:GridColumn FieldName="FullName" IsSmart="True"/>
    <dxg:GridColumn FieldName="BirthDate" IsSmart="True"/>
    <dxg:GridColumn FieldName="JobTitle" IsSmart="True"/>
    <dxg:GridColumn FieldName="Country" IsSmart="True"/>
    <dxg:GridControl.View>
        <dxg:TreeListView KeyFieldName="Id" 
                          ParentFieldName="ParentId" 
                          AutoWidth="True" 
                          ShowNodeImages="True" 
                          ImageFieldName="Image"/>
    </dxg:GridControl.View>
</dxg:GridControl>

C#
VB.NET

csharp

public class Employee {
    public int Id { get; set; }
    public int ParentId { get; set; }
    public string FullName { get; set; }
    public DateTime BirthDate { get; set; }
    public string JobTitle { get; set; }
    public string Country { get; set; }
    public byte[] Image { get; set; }
}

Public Class Employee
    Public Property Id As Integer
    Public Property ParentId As Integer
    Public Property FullName As String
    Public Property BirthDate As DateTime
    Public Property JobTitle As String
    Public Property Country As String
    Public Property Image As Byte()
End Class

Use a node’s TreeListNode.Image property to display an image within it. The image specified by the TreeListNode.Image property overrides the image obtained from a data source (if the ImageFieldName property is specified).

You can implement custom logic to display node images. To do this, use the TreeListView.NodeImageSelector property.

Refer to the following demo for an example of how to use the ImageFieldName property:

Run Demo: Child Node Selector