Skip to main content

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

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

public string KeyFieldName { get; set; }

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.

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.

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.

See Also