PivotGridFieldOptions.AllowExpand Property

Gets or sets whether an end-user is allowed to expand/collapse the rows or columns which correspond to the current field.

Namespace: DevExpress.XtraPivotGrid

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

NuGet Package: DevExpress.PivotGrid.Core

Declaration

C#

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

VB.NET

<DefaultValue(DefaultBoolean.Default)>
Public Property AllowExpand As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	Default	A DefaultBoolean enumeration value which specifies whether end-users can expand/collapse the field’s rows or columns.

Available values:

Name	Description
True	true. DefaultBoolean.True has a constant value of 0, while the standard true value corresponds to a value of 1. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
False	false. DefaultBoolean.False has a constant value of 1, while the standard false value corresponds to a value of 0. In Visual Basic, do not use implicit conversion of Boolean values to DefaultBoolean, and vice versa, as the conversion may produce incorrect results.
Default	The default behavior determined by the control’s logic.

Property Paths

You can access this nested property as listed below:

Object Type	Path to AllowExpand
PivotGridFieldBase	.Options .AllowExpand

Remarks

This property is in effect for fields displayed within the Column Header Area and Row Header Area. It specifies whether expand buttons are displayed within Field Value boxes and thus it determines whether an end-user can expand/collapse specific rows/columns.

If the AllowExpand property is set to DefaultBoolean.Default the ability to expand/collapse rows/columns is determined by the control’s PivotGridOptionsCustomization.AllowExpand property.

Set the AllowExpand property to DefaultBoolean.False to prevent an end-user from expanding/collapsing the corresponding rows/columns.

If the AllowExpand property is set to DefaultBoolean.True an end-user can expand/collapse the corresponding rows/columns regardless of the PivotGridOptionsCustomization.AllowExpand property’s value.