OptionsLayoutGrid.StoreDataSettings Property

Gets or sets whether the control’s grouping, sorting, filtering settings and summaries are stored when the layout is saved to storage and restored when the layout is restored from storage.

Namespace: DevExpress.Utils

Assembly: DevExpress.Data.v20.2.dll

NuGet Packages: DevExpress.Data, DevExpress.WindowsDesktop.Data

Declaration

C#

[DefaultValue(true)]
public bool StoreDataSettings { get; set; }

VB.NET

<DefaultValue(True)>
Public Property StoreDataSettings As Boolean

Property Value

Type	Default	Description
Boolean	**true**	true if the control’s grouping, sorting, filtering settings and summaries are included in the layout when it’s saved to storage and these settings are restored when the layout is restored from storage; otherwise, false.

Property Paths

You can access this nested property as listed below:

Show 11 property paths

Library	Object Type	Path to StoreDataSettings
WinForms Controls	ColumnView	.OptionsLayout .StoreDataSettings
	TileView	.OptionsLayout .StoreDataSettings
	WinExplorerView	.OptionsLayout .StoreDataSettings
	PivotGridControl	.OptionsLayout .StoreDataSettings
	PropertyGridControl	.OptionsLayout .StoreDataSettings
	VGridControl	.OptionsLayout .StoreDataSettings
	VGridControlBase	.OptionsLayout .StoreDataSettings
Reporting	XRPivotGrid	.OptionsLayout .StoreDataSettings
ASP.NET Web Forms Controls	ASPxPivotGrid	.OptionsLayout .StoreDataSettings
	ASPxPivotGrid	.FullLayout .StoreDataSettings
PivotGridWebOptionsLayout	.FullLayout .StoreDataSettings
ASP.NET MVC Extensions	MVCxPivotGrid	.OptionsLayout .StoreDataSettings
MVCxPivotGrid	.FullLayout .StoreDataSettings

Remarks

This option determines if the control’s grouping, sorting, filtering settings and summaries are included in the control’s layout when it’s saved to storage (a stream, xml file or the system registry). If the OptionsLayoutGrid.StoreAllOptions option is set to false, the settings that are included in the layout when it’s stored are dependent upon the options of the OptionsLayoutGrid object (only those settings which have their corresponding Store… properties set to true will be included).

If the layout is being restored from storage and the StoreDataSettings 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 control’s corresponding options will be set to their default values.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the StoreDataSettings 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-set-custom-names-for-grid-filters-and-save-restore-these-names-with-a-grid-layout-t329217/CS/WindowsApplication3/FilterNameProvider.cs#L22

this.view = view;
view.OptionsLayout.StoreDataSettings = true;
filters = new List<GridFitlerItem>();

VB.NET

how-to-set-custom-names-for-grid-filters-and-save-restore-these-names-with-a-grid-layout-t329217/VB/WindowsApplication3/FilterNameProvider.vb#L22

Me.view = view
view.OptionsLayout.StoreDataSettings = True
filters = New List(Of GridFitlerItem)()