PivotGridOptionsLayout.StoreLayoutOptions Property

Gets or sets whether options that specify how a pivot grid layout is stored/restored from a storage are stored/restored from the storage together with the layout.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

C#

[XtraSerializableProperty]
[DefaultValue(false)]
public virtual bool StoreLayoutOptions { get; set; }

VB.NET

<XtraSerializableProperty>
<DefaultValue(False)>
Public Overridable Property StoreLayoutOptions As Boolean

Property Value

Type	Default	Description
Boolean	**false**	true, if options that specify how a pivot grid layout is stored/restored from a storage are stored/restored from the storage together with the layout; otherwise, false.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to StoreLayoutOptions
WinForms Controls	PivotGridControl	.OptionsLayout.StoreLayoutOptions
Reporting	XRPivotGrid	.OptionsLayout.StoreLayoutOptions
ASP.NET Web Forms Controls	ASPxPivotGrid	.OptionsLayout.StoreLayoutOptions
	PivotGridWebOptionsLayout	.FullLayout.StoreLayoutOptions
	MVCxPivotGrid	.OptionsLayout.StoreLayoutOptions

Remarks

The StoreLayoutOptions property determines if options that specify how a pivot grid layout is stored/restored from a storage are included in the control’s layout when it is saved to a storage (a stream, XML file or the system registry). For XtraPivotGrid, these are options accessed via the PivotGridControl.OptionsLayout property.

If the OptionsLayoutGrid.StoreAllOptions property is set to true, these options are included in the control’s layout, regardless of the StoreLayoutOptions property value.

To specify whether to store a pivot grid layout, use the OptionsColumnLayout.StoreLayout property. You can access an OptionsColumnLayout object that exposes this property via the OptionsLayoutGrid.Columns property.

If the layout is being restored from a storage and the StoreLayoutOptions option is set to true, the control will try to load the appropriate options from storage. If these options cannot be found in the stored layout, the corresponding pivot grid options will be set to their default values.

To learn more, see Layout Options (XtraGrid, XtraPivotGrid).