TreeList.ShowEditor() Method

Switches the TreeList control to edit mode.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v24.1.dll

NuGet Packages: DevExpress.Win.Navigation, DevExpress.Win.TreeList

Declaration

C#

public virtual void ShowEditor()

VB.NET

Public Overridable Sub ShowEditor

Remarks

Use the ShowEditor method to activate the current cell’s editor. An end-user can do the same by clicking a cell or pressing the ENTER or SPACE key when the cell is focused. The ShowEditor method can be useful, for instance, if you want to switch the TreeList control to edit mode in response to other user actions.

A cell’s editor cannot be activated in the following cases:

• The TreeListOptionsBehavior.Editable option is disabled.
• The current column’s TreeListOptionsColumn.ReadOnly option is enabled. This option is accessible via the column’s TreeListColumn.OptionsColumn property.
• The TreeList.ShowingEditor event handler sets its Cancel parameter to true.

Use the TreeList.CanShowEditor property to determine whether the current cell’s editor can be activated. This property checks all conditions listed above, in order to return its value.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ShowEditor() method.

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#

winforms-treelist-customize-node-menu/CS/Form1.cs#L27

    treeList1.OptionsBehavior.Editable = !treeList1.OptionsBehavior.Editable;
    treeList1.ShowEditor();
}

VB.NET

winforms-treelist-customize-node-menu/VB/Form1.vb#L29

    treeList1.OptionsBehavior.Editable = Not treeList1.OptionsBehavior.Editable
    treeList1.ShowEditor()
End Sub