GetLayout Method

Description

The GetLayout method retrieves the currently used docking pane layout.

Syntax

Public Sub GetLayout( _
    ByVal [Layout] As DockingPaneLayout _
)

Parameters

Layout: Reference to a DockingPaneLayout object that will contain the currently used docking pane layout.

Return Type

The GetLayout method retrieves the state/layout of all the docking panes at the time the method is called. The state/layout information is stored in a DockingPaneLayout object. Before the GetLayout method can be called, a DockingPaneLayout object must be created to store the layout information. The CreateLayout method is used to create a DockingPaneLayout object to store the state/layout information.

The GetLayout method allows the layout to be saved so it can be used at a later time to restore the layout to a previous state. To later restore the state/layout of the docking panes to the state/layout stored in a DockingPaneLayout object, the SetLayout method is used.

Notes

The DockingPaneLayout object holds the same layout information that the SaveState and SaveStateToString methods save.
The main advantage of using the CreateLayout, 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.