PivotGridWebOptionsLayout.DefaultLayout Property

Returns a PivotGridWebOptionsLayout object whose settings indicate that fields should be overridden when saving or restoring the control layout.

Namespace: DevExpress.Web.ASPxPivotGrid

Assembly: DevExpress.Web.ASPxPivotGrid.v19.2.dll

Declaration

C#

public static PivotGridWebOptionsLayout DefaultLayout { get; }

VB.NET

Public Shared ReadOnly Property DefaultLayout As PivotGridWebOptionsLayout

Property Value

Type	Description
PivotGridWebOptionsLayout	A PivotGridWebOptionsLayout object whose settings indicate that fields should be overridden when saving or restoring the control layout.

Property Paths

You can access this nested property as listed below:

Object Type	Path to DefaultLayout
ASPxPivotGrid	.OptionsLayout.DefaultLayout
MVCxPivotGrid	.OptionsLayout.DefaultLayout

Remarks

The pivot grid allows you to select which options to save to (or restore from) a storage when saving (restoring) a layout. For this purpose, ASPxPivotGrid provides specific overloads of its LoadLayoutFrom… and SaveLayoutTo… methods that take a PivotGridWebOptionsLayout object as the optionsLayout parameter. This object determines which settings should be affected.

Pass the DefaultLayout object as the optionsLayout parameter to allow fields contained in the pivot grid to override fields contained in a layout storage when the control layout is saved to this storage, and allow fields contained in the layout storage to override fields contained in the pivot grid when the control layout is restored.

Note

Use the DefaultLayout property for backward compatibility with v10.2 and earlier (for instance, if you are restoring a layout saved with an old version, or saving a layout that will be restored with it).

Related GitHub Examples

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

save-load-field-values-collapsed-states-together-with-pivot-grids-layout-e20015/CS/ASPxPivotGrid_SaveLoadCollapsedState/Default.aspx.cs#L10

protected void btnSave_Click(object sender, EventArgs e) {
    Session["Layout"] = ASPxPivotGrid1.SaveLayoutToString( PivotGridWebOptionsLayout.DefaultLayout );
    MemoryStream collapseStateStream = (MemoryStream)(Session["CollapseStateStream"]);

VB.NET

save-load-field-values-collapsed-states-together-with-pivot-grids-layout-e20015/VB/ASPxPivotGrid_SaveLoadCollapsedState/Default.aspx.vb#L12

Protected Sub btnSave_Click(ByVal sender As Object, ByVal e As EventArgs)
    Session("Layout") = ASPxPivotGrid1.SaveLayoutToString(PivotGridWebOptionsLayout.DefaultLayout)
    Dim collapseStateStream As MemoryStream = CType(Session("CollapseStateStream"), MemoryStream)