TreeList.CheckBoxFieldName Property
Gets or sets the name of the field whose values define the node check states.
Namespace: DevExpress.XtraTreeList
Assembly: DevExpress.XtraTreeList.v19.1.dll
Declaration
[DefaultValue("")]
[XtraSerializableProperty]
public string CheckBoxFieldName { get; set; }
Property Value
Type | Default | Description |
---|---|---|
String | String.Empty | The name of the field to bind to the node check states. |
Remarks
To synchronize the node check states with a data source field, assign this field’s name to the CheckBoxFieldName property. In this instance, nodes’ initial check states are retrieved from this field. When a node is checked or unchecked, its new state is saved to this field.
The following list describes the data source values to which the node check states correspond.
- Checked state corresponds to true
- Unchecked state corresponds to false
Indeterminate state corresponds to null.
If the Indeterminate state is allowed, the bound data source field should be of the Nullable Boolean data type.
See Node Checking - Checkboxes and Radio Buttons to learn more.
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CheckBoxFieldName 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.