ASPxTreeList.KeyFieldName Property

Gets or sets the name of the data source key field.

Namespace: DevExpress.Web.ASPxTreeList

Assembly: DevExpress.Web.ASPxTreeList.v19.2.dll

Declaration

C#

[DefaultValue("")]
public string KeyFieldName { get; set; }

VB.NET

<DefaultValue("")>
Public Property KeyFieldName As String

Property Value

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

Remarks

Since the ASPxTreeList control is designed to display information in a tree structure, its data source should meet certain requirements. If a data source contains flat data, two additional fields are necessary to build a tree structure.

• The first field must contain unique values. This field must be assigned to the KeyFieldName property.
• The second field must contain key values of parent nodes for the current node. It should be assigned to the ASPxTreeList.ParentFieldName property.

Note

The data types of the KeyField and ParentField fields must be the same.

Important

When the ASPxTreeList control is bound to a hierarchical data source (e.g. XmlDataSource), the KeyFieldName and ASPxTreeList.ParentFieldName properties are not in effect.

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.

C#

how-to-bind-aspxtreelist-to-xpo-data-e1288/CS/Default.aspx.cs#L11

XpoDataSource1.Session = session;
ASPxTreeList1.KeyFieldName = "Oid";
ASPxTreeList1.ParentFieldName = "Parent!Key";

how-to-reload-grid-data-when-navigating-the-treelist-e934/CS/SyncWithGridOnUpdatePanel/Default.aspx.cs#L21

ASPxTreeList1.DataSource = GetData();
ASPxTreeList1.KeyFieldName = "ID";

VB.NET

how-to-bind-aspxtreelist-to-xpo-data-e1288/VB/Default.aspx.vb#L13

XpoDataSource1.Session = workSession
ASPxTreeList1.KeyFieldName = "Oid"
ASPxTreeList1.ParentFieldName = "Parent!Key"

how-to-reload-grid-data-when-navigating-the-treelist-e934/VB/SyncWithGridOnUpdatePanel/Default.aspx.vb#L23

ASPxTreeList1.DataSource = GetData()
ASPxTreeList1.KeyFieldName = "ID"