Skip to content

LoadLayoutFromXML - cCJCommandBarSystem

Loads a command bar system's layout from an XML File

Type: Function
Return Data Type: Boolean

Parameters

Parameter Type Description
eLayout Integer Determines what is restored. Possible values are:ConstantMeaning
sFileName String Full path and file name of the XML file to be loaded from

Syntax

Function LoadLayoutFromXML Integer eLayout String sFileName Returns Boolean

Call Example

Get LoadLayoutFromXML eLayout sFileName to BooleanVariable

Description

LoadLayoutFromXML loads a command bar system's layout from an XML file.

The eLayout parameter determines what information is used to restore the layout.

By default this message is not sent during the activation of a command bar system. Layout information is normally restored from the registry using theLoadLayoutFromRegistry method. LoadLayoutFromXML was provided to make it easy to alter this default behavior and to use an XML file instead.

You will typically not augment this method. If you send this method you will mostly likely do so within an augmentation of LoadEnvironment. See LoadEnvironment for an example of replacing LoadLayoutFromRegistry with LoadLayoutFromXML.

Return Value

Returns True if layout was successfully loaded from the XML file