Back to Devexpress

SpreadsheetColumnBehaviorOptions.Insert Property

officefileapi-devexpress-dot-xtraspreadsheet-dot-spreadsheetcolumnbehavioroptions.md

latest3.5 KB
Original Source

SpreadsheetColumnBehaviorOptions.Insert Property

Gets or sets the document’s capability to insert new columns.

Namespace : DevExpress.XtraSpreadsheet

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
[DefaultValue(DocumentCapability.Default)]
public virtual DocumentCapability Insert { get; set; }
vb
<DefaultValue(DocumentCapability.Default)>
Public Overridable Property Insert As DocumentCapability

Property Value

TypeDefaultDescription
DocumentCapabilityDefault

A DocumentCapability enumeration value specifying the document’s capability to perform an operation.

|

Available values:

NameDescription
Default

The value is determined by the current setting. The default value is automatically set if it is not explicitly specified.

| | Disabled |

The feature is not allowed and the corresponding commands are shown disabled.

| | Enabled |

The feature is available and the corresponding commands are shown enabled.

| | Hidden |

The feature is not available and the corresponding commands are hidden.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to Insert
SpreadsheetBehaviorOptions

.Column .Insert

|

Remarks

The DocumentCapability.Default value for the Insert property is equal to DocumentCapability.Enabled, so that inserting new columns is available for a document currently loaded in the SpreadsheetControl.

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Insert 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.

winforms-spreadsheet-custom-draw-example/VB/CustomDrawExample/Form1.vb#L17

vb
spreadsheetControl1.Options.Behavior.Column.Delete = DocumentCapability.Disabled
spreadsheetControl1.Options.Behavior.Column.Insert = DocumentCapability.Disabled

See Also

SpreadsheetColumnBehaviorOptions Class

SpreadsheetColumnBehaviorOptions Members

DevExpress.XtraSpreadsheet Namespace