Back to Devexpress

TreeListOptionsColumn.AllowEdit Property

windowsforms-devexpress-dot-xtratreelist-dot-columns-dot-treelistoptionscolumn.md

latest7.0 KB
Original Source

TreeListOptionsColumn.AllowEdit Property

Specifies if users can edit column values in tree list cells (inplace edit mode).

Namespace : DevExpress.XtraTreeList.Columns

Assembly : DevExpress.XtraTreeList.v25.2.dll

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

Declaration

csharp
[DefaultValue(true)]
[XtraSerializableProperty]
public virtual bool AllowEdit { get; set; }
vb
<DefaultValue(True)>
<XtraSerializableProperty>
Public Overridable Property AllowEdit As Boolean

Property Value

TypeDefaultDescription
Booleantrue

true to allow users to edit cell values; otherwise, false.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to AllowEdit
TreeListColumn

.OptionsColumn .AllowEdit

|

Remarks

The AllowEdit option is in effect if the tree list’s TreeList.OptionsBehavior.Editable property is set to true and the EditingMode property is set to Default or Inplace.

Handle the TreeList.ShowingEditor event to prevent a user from changing the value in individual cells. This event occurs when an inplace editor is about to open, and allows you to cancel this action.

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

xaf-win-enable-inplace-editing-in-tree-list-view/CS/EFCore/TreeListInplaceEF/TreeListInplaceEF.Win/Controllers/TreeListInplaceEditViewController.cs#L59

csharp
if (modelColumn != null)
        columnWrapper.Column.OptionsColumn.AllowEdit = modelColumn.AllowEdit;
}

winforms-treelist-unbound-columns/CS/TreeList_UnboundDataViaEvent/Form1.cs#L29

csharp
unbColumnMarchChange.Visible = true;
unbColumnMarchChange.OptionsColumn.AllowEdit = false;
unbColumnMarchChange.FieldName = "ChangeFromPrevYear";

winforms-spreadsheet-chart-api/CS/SpreadsheetChartAPISamples/Form1.cs#L158

csharp
col1.VisibleIndex = 0;
col1.OptionsColumn.AllowEdit = false;
col1.OptionsColumn.AllowMove = false;

winforms-spreadsheet-pivot-table-api/CS/SpreadsheetPivotTableExamples/Form1.cs#L146

csharp
col1.VisibleIndex = 0;
col1.OptionsColumn.AllowEdit = false;
col1.OptionsColumn.AllowMove = false;

winforms-spreadsheetcontrol-api-part-3/CS/SpreadsheetControl_API_Part03/Form1.cs#L319

csharp
col1.VisibleIndex = 0;
col1.OptionsColumn.AllowEdit = false;
col1.OptionsColumn.AllowMove = false;

winforms-treelist-unbound-columns/VB/TreeList_UnboundDataViaEvent/Form1.vb#L24

vb
unbColumnMarchChange.Visible = True
unbColumnMarchChange.OptionsColumn.AllowEdit = False
unbColumnMarchChange.FieldName = "ChangeFromPrevYear"

winforms-spreadsheet-chart-api/VB/SpreadsheetChartAPISamples/Form1.vb#L153

vb
col1.VisibleIndex = 0
col1.OptionsColumn.AllowEdit = False
col1.OptionsColumn.AllowMove = False

winforms-spreadsheet-pivot-table-api/VB/SpreadsheetPivotTableExamples/Form1.vb#L139

vb
col1.VisibleIndex = 0
col1.OptionsColumn.AllowEdit = False
col1.OptionsColumn.AllowMove = False

winforms-spreadsheetcontrol-api-part-3/VB/SpreadsheetControl_API_Part03/Form1.vb#L322

vb
col1.VisibleIndex = 0
col1.OptionsColumn.AllowEdit = False
col1.OptionsColumn.AllowMove = False

winforms-richeditcontrol-common-api/VB/RichEditAPISample/Form1.vb#L417

vb
col1.VisibleIndex = 0
col1.OptionsColumn.AllowEdit = False
col1.OptionsColumn.AllowMove = False

See Also

Editable

EditingMode

ShowingEditor

TreeListOptionsColumn Class

TreeListOptionsColumn Members

DevExpress.XtraTreeList.Columns Namespace