SpreadsheetBehaviorOptions.Drag Property

Gets or sets whether the Drag operation is permitted.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

C#

[DefaultValue(DocumentCapability.Default)]
public DocumentCapability Drag { get; set; }

VB.NET

<DefaultValue(DocumentCapability.Default)>
Public Property Drag As DocumentCapability

Property Value

Type	Default	Description
DocumentCapability	**Default**	A DocumentCapability enumeration value specifying the document’s capability to perform an operation.

Available values:

Name	Description
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 Type	Path to Drag
SpreadsheetControlOptions	.Behavior.Drag

Remarks

When the Drag property is set to DocumentCapability.Disabled value, all drag operations in the SpreadsheetControl are disabled, including dragging ranges, pictures and comments. However, there are certain details concerning cell range operations which are described below.

The effect of different Drag settings on the selected range is as follows:

• Default All drag operations are allowed. Fill handle (a small square in the lower-right corner of the selection, used to automatically fill adjacent cells with a data series) is enabled. The end-user can also move range data by dragging the selected range to another location.

  

• Enabled

  Drag operations are allowed. Fill handle and move range operations are enabled. You can use the SpreadsheetBehaviorOptions.FillHandle and SpreadsheetBehaviorOptions.MoveRange properties to disable the features individually.

  

• Disabled

  All drag operations are prohibited. If the SpreadsheetBehaviorOptions.MoveRange value is DocumentCapability.Default, the fill handle is disabled, ignoring any SpreadsheetBehaviorOptions.FillHandle value and the end-user cannot move range data by dragging the selected range to another location.

  

  However, if the MoveRange capability is set to either Enabled or Disabled, the FillHandle value is in effect.

  

Related GitHub Examples

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

how-to-display-custom-controls-instead-of-the-standard-cell-editor-t259398/CS/SpreadsheetCustomization/Form1.cs#L38

spreadsheetControl1.Options.Behavior.Selection.AllowExtendSelection = false;
spreadsheetControl1.Options.Behavior.Drag = DevExpress.XtraSpreadsheet.DocumentCapability.Disabled;
spreadsheetControl1.Options.VerticalScrollbar.Visibility = DevExpress.XtraSpreadsheet.SpreadsheetScrollbarVisibility.Hidden;

VB.NET

how-to-display-custom-controls-instead-of-the-standard-cell-editor-t259398/VB/SpreadsheetCustomization/Form1.vb#L40

spreadsheetControl1.Options.Behavior.Selection.AllowExtendSelection = False
spreadsheetControl1.Options.Behavior.Drag = DevExpress.XtraSpreadsheet.DocumentCapability.Disabled
spreadsheetControl1.Options.VerticalScrollbar.Visibility = DevExpress.XtraSpreadsheet.SpreadsheetScrollbarVisibility.Hidden