TreeListOptionsBehavior.Editable Property

Gets or sets whether end-users are allowed to invoke cell editors.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v19.1.dll

Declaration

C#

[DefaultValue(true)]
[XtraSerializableProperty]
public virtual bool Editable { get; set; }

VB.NET

<DefaultValue(True)>
<XtraSerializableProperty>
Public Overridable Property Editable As Boolean

Property Value

Type	Default	Description
Boolean	**true**	true if end-users are allowed to invoke cell editors; otherwise, false.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to Editable
WinForms Controls	ResourcesTree	.OptionsBehavior.Editable
	TreeList	.OptionsBehavior.Editable
Reporting	XRDesignFieldList	.OptionsBehavior.Editable
	XRDesignReportExplorer	.OptionsBehavior.Editable

Remarks

When the Editable option is set to true editors can still be prevented from being invoked for individual columns if required. Disable the column’s TreeListOptionsColumn.AllowEdit option for this purpose.

To prevent individual cells from being edited, handle the Tree List’s TreeList.ShowingEditor event.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Editable 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#

implementing-context-menus-for-treelist-nodes-e847/CS/Form1.cs#L26

private void bbEdit_ItemClick(object sender, EventArgs e) {
    treeList1.OptionsBehavior.Editable = !treeList1.OptionsBehavior.Editable;
    treeList1.ShowEditor();

how-to-implement-tree-view-style-including-the-paint-style-and-the-capability-to-collapse-t141633/CS/WindowsApplication1/CustomTreeList/CustomTreeList.cs#L28

if (TreeViewStyle) {
    OptionsBehavior.Editable = false;
    OptionsView.ShowColumns = false;

XAF_how-to-show-hierarchical-resources-in-schedulerlisteditor-winforms-e4601/CS/WinSolution.Module.Win/Editors/SchedulerListEditor.cs#L31

resourcesTree.Width = 150;
resourcesTree.OptionsBehavior.Editable = false;
resourcesTree.KeyFieldName = this.ResourcesMappings.Id;

XAF_treelisteditor-how-to-enable-in-place-editing-in-the-winforms-tree-list-view-xpo-e443/CS/WinSolution.Module.Win/TreeListInplaceEditViewController.cs#L52

if (treeList != null) {
    treeList.OptionsBehavior.Editable = treeListEditor.AllowEdit;
    foreach (RepositoryItem ri in treeList.RepositoryItems) {

how-to-implement-the-document-map-feature-for-richeditcontrols-document-using-a-treelist-c-t164630/CS/WindowsFormsApplication1/Form1.cs#L45

treeList1.OptionsBehavior.Editable = false;
treeList1.FocusedNodeChanged += new DevExpress.XtraTreeList.FocusedNodeChangedEventHandler(treeList1_FocusedNodeChanged);

VB.NET

implementing-context-menus-for-treelist-nodes-e847/VB/Form1.vb#L28

Private Sub bbEdit_ItemClick(ByVal sender As Object, ByVal e As EventArgs)
    treeList1.OptionsBehavior.Editable = Not treeList1.OptionsBehavior.Editable
    treeList1.ShowEditor()

how-to-implement-tree-view-style-including-the-paint-style-and-the-capability-to-collapse-t141633/VB/WindowsApplication1/CustomTreeList/CustomTreeList.vb#L30

If TreeViewStyle Then
    OptionsBehavior.Editable = False
    OptionsView.ShowColumns = False

XAF_how-to-show-hierarchical-resources-in-schedulerlisteditor-winforms-e4601/VB/WinSolution.Module.Win/Editors/SchedulerListEditor.vb#L36

resourcesTree.Width = 150
resourcesTree.OptionsBehavior.Editable = False
resourcesTree.KeyFieldName = Me.ResourcesMappings.Id

XAF_treelisteditor-how-to-enable-in-place-editing-in-the-winforms-tree-list-view-xpo-e443/VB/WinSolution.Module.Win/TreeListInplaceEditViewController.vb#L54

If treeList IsNot Nothing Then
    treeList.OptionsBehavior.Editable = treeListEditor.AllowEdit
    For Each ri As RepositoryItem In treeList.RepositoryItems

how-to-implement-the-document-map-feature-for-richeditcontrols-document-using-a-treelist-c-t164630/VB/WindowsFormsApplication1/Form1.vb#L50

treeList1.OptionsBehavior.Editable = False
AddHandler treeList1.FocusedNodeChanged, AddressOf treeList1_FocusedNodeChanged