rxBackstageTab

Description

rxBackstageTab models element CT_BackstageTab of the MS Custom UI XML specification which specifies a Backstage tab control.

Properties

Property Name	Description
columnWidthPercent	The percentage of the Backstage width occupied by a tab
enabled	Whether the controls is enabled
firstColumnMaxWidth	The maximum width of a backstage tab's first column
firstColumnMinWidth	The minimum width of a backstage tab's first column
id	The ID of a custom UI element. IDs must be unique
idMso	The ID of a built-in control
idQ	A qualified control ID. Qualified IDs allow different add-ins to modify the same custom group, tab, or menu
insertAfterMso	The ID of a built-in control to be inserted after
insertAfterQ	The ID of a control to be inserted after
insertBeforeMso	The ID of a built-in control to be inserted before
insertBeforeQ	The ID of control to be inserted before
isEmpty	Read-only property; returns true if the control is empty
isLive	Read-only property; returns true if the control is live
keytip	Sets the control's keytip
label	Sets the control's label
parent	The control's parent object
secondColumnMaxWidth	The maximum width of a backstage tab's second column
secondColumnMinWidth	The minimum width of a backstage tab's second column
tag	Custom data
title	The control's title
visible	Whether the control is visible
xml	Returns the xml node that corresponds to the state of the control

Contained Controls

Property Name	Description
firstColumn	A collection of Backstage controls
ribbonXControls	The collection of all contained ribbonX controls
secondColumn	A collection of Backstage controls

Methods

Method Name	Description
clear	Clears the control's state
clone	Creates a clone of the control (a new id is automatically created if applicable)
readXml	Populates the control using the passed-in XML string

Delegates

Delegate Name	Description
getEnabled	Callback that sets the control's enabled state
getKeytip	Callback that sets the keytip
getLabel	Callback that sets the label
getTitle	Callback that sets the control's title
getVisible	Callback that sets the control's visible state

Events

Event Name	Description
OnGetEnabled	Callback that sets the control's enabled state
OnGetKeytip	Callback that sets the keytip
OnGetLabel	Callback that sets the label
OnGetTitle	Callback that sets the control's title
OnGetVisible	Callback that sets the control's visible state