PivotGridFieldOptions.AllowDrag Property

Gets or sets whether an end-user is allowed to drag the Field Header.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v18.2.Core.dll

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
[XtraSerializableProperty]
public DefaultBoolean AllowDrag { get; set; }

VB.NET

<DefaultValue(DefaultBoolean.Default)>
<XtraSerializableProperty>
Public Property AllowDrag As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	**Default**	A DefaultBoolean enumeration value specifying whether end-users can drag the field’s header.

Available values:

Name	Description
True	Corresponds to a Boolean value of true.
False	Corresponds to a Boolean value of false.
Default	The value is determined by the current object’s parent object setting (e.g., a control setting).

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to AllowDrag
Cross-Platform Class Library	PivotGridFieldBase	.Options.AllowDrag
WinForms Controls	PivotGridField	.Options.AllowDrag
ASP.NET Controls and MVC Extensions	PivotGridField	.Options.AllowDrag
	MVCxPivotGridField	.Options.AllowDrag
Reporting	XRPivotGridField	.Options.AllowDrag

Remarks

If the AllowDrag property is set to DefaultBoolean.Default the ability to drag a field’s header is determined by the control’s PivotGridOptionsCustomization.AllowDrag property.

Set the AllowDrag property to DefaultBoolean.False to prevent an end-user from dragging this field’s header.

If the AllowDrag property is set to DefaultBoolean.True an end-user can drag a field regardless of the PivotGridOptionsCustomization.AllowDrag property’s value.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AllowDrag 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-prevent-pivotgridfieldoptions-property-from-being-serialized-e2230/CS/DxSample/Form1.cs#L52

foreach(PivotGridField field in pivotGrid1.Fields) {
    field.Options.AllowDrag = DevExpress.Utils.DefaultBoolean.False;
}

VB.NET

how-to-prevent-pivotgridfieldoptions-property-from-being-serialized-e2230/VB/DxSample/Form1.vb#L56

For Each field As PivotGridField In pivotGrid1.Fields
    field.Options.AllowDrag = DevExpress.Utils.DefaultBoolean.False
Next field