Difference between revisions of "RxBackstage"
From Ribbon Commander Documentation
| (2 intermediate revisions by the same user not shown) | |||
| Line 19: | Line 19: | ||
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | {{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | ||
{{DocTableColEntry | controlName=rxBackstage| propName=buttons}} | {{DocTableColEntry | controlName=rxBackstage| propName=buttons}} | ||
| − | |||
{{DocTableEntry | name=ribbonXControls}} | {{DocTableEntry | name=ribbonXControls}} | ||
{{DocTableColEntry | controlName=rxBackstage| propName=tabs}} | {{DocTableColEntry | controlName=rxBackstage| propName=tabs}} | ||
Latest revision as of 12:10, 15 March 2013
Contents
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 |
