All docs
V20.1
20.2 (EAP/Beta)
20.1
19.2
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

TreeListMappings.KeyFieldName Property

Gets or sets the name of the key field that uniquely identifies records in the data source.

Namespace: DevExpress.XtraGantt

Assembly: DevExpress.XtraGantt.v20.1.dll

Declaration

[DefaultValue("ID")]
[XtraSerializableProperty]
public string KeyFieldName { get; set; }
<DefaultValue("ID")>
<XtraSerializableProperty>
Public Property KeyFieldName As String

Property Value

Type Default Description
String

"ID"

The key identifier field name.

Remarks

The DataSource property allows you to bind the control to a data source. The KeyFieldName property specifies a task's unique identifier (key). See the TreeList.KeyFieldName property for more information.

The ParentFieldName property specifies a parent task's key. This field allows you to organize tasks in a tree. See the TreeList.ParentFieldName property for more information.

You can also use a task's key to specify the task's predecessor(s).

If you need finish-to-start dependencies only, use the PredecessorsFieldName property to specify the data field that contains predecessors' keys. The data should be of the System.Collections.IEnumerable type. The enumerator should return key values of the same type as the key field. In particular, you can use the following types:

  • IList — use this type to allow users to modify dependencies and save changes to the data source. The collection should not be read only.
  • String — the string should contain keys separated by space, comma, or semicolon (' ', ',' ';').

If you need finish-to-start and other dependency types, use the PredecessorFieldName and SuccessorFieldName properties and a separate data source assigned to the DependencySource property. See Task Dependencies for more information.

See Also