TreeListView.KeyFieldName Property

Gets or sets the name of the service field in a data source that contains unique values. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

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

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public string KeyFieldName { get; set; }

VB.NET

Public Property KeyFieldName As String

Property Value

Type	Description
String	The name of the field that contains unique values.

Remarks

If you want to implement the Self-Referential data structure, you should include two service fields in your data source:

Key Field

Contains unique values. Assign this field to the KeyFieldName property.

Parent Field

Identifies the parent node. Assign this field to the ParentFieldName property.

Columns bound to these fields are called service columns.

Both KeyFieldName and ParentFieldName properties support nested fields (for example, Account.Id).

Limitations

• The Key and Parent fields should have the same data type.
• A node cannot have equal Key and Parent field values.
• Do not use Unbound columns as service columns.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the KeyFieldName 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.

XAML

wpf-tree-list-calculate-custom-node-summaries/CS/CustomNodeSummaries_CodeBehind/MainWindow.xaml#L14

<dxg:TreeListView AutoExpandAllNodes="True" AutoWidth="True"
                  KeyFieldName="ID" ParentFieldName="ParentID"
                  ShowNodeFooters="True"

wpf-treelist-iterate-through-nodes-with-the-treelistnodeiterator/CS/WpfApplication1/MainWindow.xaml#L13

    <dxg:TreeListView x:Name="view" AutoWidth="True"
                      KeyFieldName="ID" ParentFieldName="ParentID"/>
</dxg:GridControl.View>

wpf-lookupedit-display-treelist-as-popup-content/CS/CustomTreeViewComboBox/MainWindow.xaml#L19

AutoExpandAllNodes="True"
KeyFieldName="ID"
ParentFieldName="ParentID"

wpf-tree-list-generate-node-summaries-from-collection/CS/TreeList_DataBinding/MainWindow.xaml#L32

<dxg:TreeListView Name="treeListView1" AutoWidth="False" ShowTotalSummary="True"
                  KeyFieldName="ID" ParentFieldName="ParentID"
                  NodeSummarySource="{Binding SummaryList}" NodeSummaryGeneratorTemplate="{StaticResource SummaryTemplate}" ShowNodeFooters="True"/>

wpf-tree-list-display-node-summaries/CS/TreeList_DataBinding/MainWindow.xaml#L21

<dxg:TreeListView Name="treeListView1" AutoWidth="True"
                  KeyFieldName="ID" ParentFieldName="ParentID"
                  ShowNodeFooters="True">