Skip to content

SaveStateToXMLString Method

Description

The SaveStateToXMLString method saves the Command Bar state to an XML string.

Syntax

Public Function SaveStateToXMLString( _
    ByVal [Profile](#) As String, _
    Optional ByVal [Options](#) As [StateOptions](XtremeCommandBars~StateOptions.md) = 0 _
) As String

Parameters

  • Profile
    Id of the XML string. This specifies which XML string should be loaded.

IMPORTANT: When saving an XML string, the Profile name MUST be named "DesignerFile" if you want to edit the XML file in the Designer Studio.

  • Options
    Pointer to a StateOptions object that contains information that specifies how the CommandBars state will be saved to the XML string and what parts of the CommandBars state will be saved.

Return Type

A String containing the state of the Command Bars in XML format.

Remarks

Creates a string containing the CommandBars layout, state, and settings. The state options object specifies which settings should be saved to the XML string. Since multiple strings can be saved to the same file, the Profile given identifies the XML string.

IMPORTANT: When saving an XML string, the Profile name MUST be named "DesignerFile" if you want to edit the XML file in the Designer Studio.

See Also

Example

StateOptions Object


Copyright (c) 1998-2024 Codejock Technologies. All rights reserved.