OptionsLayoutBase.FullLayout Property

Returns an OptionsLayoutBase object whose settings indicate that the full layout of the control should be stored to and restored from storage (a stream, xml file or system registry).

Namespace: DevExpress.Utils

Assembly: DevExpress.Data.v23.2.dll

NuGet Package: DevExpress.Data

Declaration

C#

public static OptionsLayoutBase FullLayout { get; }

VB.NET

Public Shared ReadOnly Property FullLayout As OptionsLayoutBase

Property Value

Type	Description
OptionsLayoutBase	A OptionsLayoutBase object whose settings indicate that the full layout of the control should be stored to/restored from storage.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to FullLayout
Cross-Platform Class Library	OptionsLayoutBase	.FullLayout .FullLayout
	PropertyAllowEventArgs	.OptionsLayout .FullLayout
WinForms Controls	BaseView	.OptionsLayout .FullLayout
	SchedulerControl	.OptionsLayout .FullLayout

Remarks

A control can provide methods to save only specific options to and restore them from storage (a stream, xml file or system registry). Such methods take a OptionsLayoutBase parameter, and this determines which settings should be affected. To affect all the possible settings when the layout is stored or restored, you can pass the FullLayout object as this parameter.

The following is applied when restoring a layout in the XtraGrid control, using one of its RestoreLayoutFrom… methods, taking the FullLayout object as a parameter. Columns added to a View after the layout has been saved will be destroyed on restoring the layout. To retain the newly added columns when restoring the layout, do not call the RestoreLayoutFrom… method with the FullLayout object as a parameter. Use one of the following solutions instead:

• Use the RestoreLayoutFrom… method overload without parameters to restore the layout. Before calling this method, enable the OptionsColumnLayout.AddNewColumns option, which is available via the View’s ColumnView.OptionsLayout property.
• Create a OptionsLayoutGrid object, enable its Columns.AddNewColumns option, and pass it to the RestoreLayoutFrom… method.

Related GitHub Examples

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

winforms-pivotgrid-save-restore-state-and-layout/CS/XtraPivotGrid_RestoreLayoutExample/Form1.cs#L23

layoutStream = new MemoryStream();
pivotGridControl1.SaveLayoutToStream(layoutStream, OptionsLayoutBase.FullLayout);
collapseStateStream.Dispose();

VB.NET

winforms-pivotgrid-save-restore-state-and-layout/VB/XtraPivotGrid_RestoreLayoutExample/Form1.vb#L25

layoutStream = New MemoryStream()
pivotGridControl1.SaveLayoutToStream(layoutStream, OptionsLayoutBase.FullLayout)
collapseStateStream.Dispose()