TreeList.State Property
Gets the control’s current state.
Namespace: DevExpress.XtraTreeList
Assembly: DevExpress.XtraTreeList.v23.2.dll
NuGet Packages: DevExpress.Win.Navigation, DevExpress.Win.TreeList
Declaration
Property Value
| Type | Description |
|---|---|
| TreeListState | A TreeListState enumeration member, indicating the Tree List’s current state. |
Available values:
| Name | Description |
|---|---|
| Regular | The Tree List is in its normal state. No specific action is being performed by an end-user. |
| ColumnDragging | A column’s header is being dragged. The column’s TreeListOptionsColumn.AllowMove option must be enabled to allow column header dragging. |
| ColumnSizing | A column’s right edge is being dragged to change the column’s width. The column’s TreeListOptionsColumn.AllowSize option must be enabled to allow such resizing. |
| ColumnPressed | A column’s header is pressed. |
| ColumnButtonPressed | The column button is clicked. |
| Editing | A cell editor is currently active. |
| OuterDragging | An external object, not one of the Tree List’s elements, is being dragged from outside over the Tree List control. |
| NodePressed | A node is currently pressed. |
| NodeDragging | A node is being dragged. See TreeListOptionsDragAndDrop.DragNodesMode. |
| NodeSizing | A node is being resized by an end-user. This implies that the node’s edge is being dragged. This operation is only available for nodes whose TreeListOptionsBehavior.ResizeNodes option is enabled. You can prevent the node from being resized by enabling the TreeListOptionsBehavior.AutoNodeHeight option. |
| Design | The Tree List is currently in design mode. |
| MultiSelection | Multiple nodes are being selected using drag and drop. The TreeListOptionsSelection.MultiSelect option must be set to true to enable this feature. |
| IncrementalSearch | An incremental search is being performed. |
| BandPressed | A band’s header is pressed. |
| BandDragging | A band’s header is being dragged. The band’s OptionsBand.AllowMove option must be enabled to allow a band header to be dragged. |
| BandSizing | A band’s right edge is being dragged to change the band’s width. The band’s OptionsBand.AllowSize option must be enabled to allow such resizing. |
| BandButtonPressed | The band button is clicked. |
| CellSelection | Multiple cells are being selected. |
Remarks
Use this property to determine which action is being performed by an end-user. Refer to the TreeListState enumeration description, for a list of all available states.
An example of using the State property can include suspension of a given operation until the end-user completes an action against the Tree List. For instance, you may need to display a notification message and suspend it, if the user is performing a dragging operation at a given moment in time.