rxBackstageGroup

Description

rxBackstageGroup models element CT_BackstageGroup of the MS Custom UI XML specification which specifies a Backstage group control.

Properties

Property Name	Description
helperText	Extended text for a backstage group
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
label	Sets the control's label
parent	The control's parent object
showLabel	Whether to show a control's label
style	The control's style
tag	Custom data
visible	Whether the control is visible
xml	Returns the xml node that corresponds to the state of the control

Contained Controls

Property Name	Description
bottomItems	A collection of controls that appear at the bottom of the backstage group
primaryItem	A container for the primary UI of the containing Backstage group control
topItems	A collection of controls that appear at the top of the backstage group
ribbonXControls	The collection of all contained ribbonX 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
getHelperText	Callback that returns the control's extended text
getLabel	Callback that sets the label
getShowLabel	Callback for whether to show the control's label
getStyle	Callback that sets the control's style
getVisible	Callback that sets the control's visible state

Events

Event Name	Description
OnGetHelperText	Callback that returns the control's extended text
OnGetLabel	Callback that sets the label
OnGetShowLabel	Callback for whether to show the control's label
OnGetStyle	Callback that sets the control's style
OnGetVisible	Callback that sets the control's visible state