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.v14.2.dll

Declaration

C#

[XtraSerializableProperty]
public string KeyFieldName { get; set; }

VB.NET

<XtraSerializableProperty>
Public Property KeyFieldName As String

Property Value

Type	Description
String	A String value that specifies the name of the data source key field.

Remarks

To display data in a tree, a data source should contain two additional fields. The first field must contain unique values. Its name is specified by the TreeListView.KeyFieldName property. The second field must contain values that indicate parent nodes for the current node. Its name is specified by the TreeListView.ParentFieldName property. Columns bound to these fields are called service columns.

NOTE

The data types of the data source fields specified by the TreeListView.KeyFieldName and TreeListView.ParentFieldName properties, must be the same. These values (key and parent) cannot be equal for a node.

To learn more, see Tree Generation Algorithm.