TreeList.CheckBoxFieldName Property

Gets or sets the name of the field whose values define the node check states.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v20.1.dll

NuGet Package: DevExpress.Win.TreeList

Declaration

C#

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

VB.NET

<DefaultValue("")>
<XtraSerializableProperty>
Public Property CheckBoxFieldName As String

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 data source field you assign to this property should be of Boolean or Nullable Boolean (in case the AllowIndeterminateCheckState property is enabled) data type.

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.

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.

C#

xtratreelist-how-to-save-state-of-checkboxes-into-the-bound-data-table-e3069/CS/XtraTreeListSaveCheckboxesState/Main.cs#L22

treeList1.DataSource = dt;
treeList1.CheckBoxFieldName = "CheckBoxState";
treeList1.Columns["CheckBoxState"].Visible = false;

VB.NET

xtratreelist-how-to-save-state-of-checkboxes-into-the-bound-data-table-e3069/VB/XtraTreeListSaveCheckboxesState/Main.vb#L24

treeList1.DataSource = dt
treeList1.CheckBoxFieldName = "CheckBoxState"
treeList1.Columns("CheckBoxState").Visible = False