rxBackstage

From Ribbon Commander Documentation
Jump to: navigation, search
RxBackstage.png

Description

rxBackstage models element CT_Backstage of the MS Custom UI XML specification which specifies a reference to the Backstage.

Properties

Property Name
Description
isEmpty Read-only property; returns true if the control is empty
isLive Read-only property; returns true if the control is live
parent The control's parent object
startFromScratch Whether the ribbon is reduced to a minimal set of features from which a completely custom ribbon can be built
xml Returns the xml node that corresponds to the state of the control

Contained Controls

Property Name
Description
buttons A collection of buttons
ribbonXControls The collection of all contained ribbonX controls
tabs A collection of tabs

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
onHide Callback invoked when the backstage is hidden
onShow Callback invoked when the backstage is shown

Events

Event Name
Description
OnHideEvent Callback invoked when the backstage is hidden
OnShowEvent Callback invoked when the backstage is shown

Remarks

Examples

VBA

  1.  

C#

  1.  

VB.NET

  1.  

C++

  1.