CreateLayout Method

Description

The CreateLayout method creates a DockingPaneLayout object to store a docking pane state/layout. The DockingPaneLayout object created is used with the GetLayout and SetLayout methods to load and set docking pane layouts.

Syntax

Public Function CreateLayout() As [DockingPaneLayout](XtremeDockingPane~DockingPaneLayout.md)

Return Type

Returns a DockingPaneLayout object to store a docking pane state/layout.

Remarks

The CreateLayout method creates a DockingPaneLayout object to store a docking pane state/layout.

To save the current state/layout of the docking panes, the GetLayout method is used. Before the GetLayout method can be called, a DockingPaneLayout object must be created using the CreateLayout method.

The SetLayout method will restore the state/layout of all the docking panes to a previous state/layout stored in a DockingPaneLayout object.

Notes

The DockingPaneLayout object holds the same layout information that the SaveState and SaveStateToString methods save.
The main advantage of using the CreateLayout (XtremeDockingPane~DockingPane~CreateLayout.md), GetLayout, and SetLayout methods over the SaveState and SaveStateToString methods is speed. It is much faster to save and restore the layout in memory rather than having to serialize to/from a string.