Difference between revisions of "RxBackstage"
From Ribbon Commander Documentation
| Line 2: | Line 2: | ||
[[Category:Controls]] | [[Category:Controls]] | ||
[[Category:2010 Controls]] | [[Category:2010 Controls]] | ||
| + | |||
| + | [[image: rxBackstage.png|right|link=]] | ||
| + | == Description == | ||
| + | rxBackstage models element [http://msdn.microsoft.com/en-us/library/dd773040(v=office.12).aspx CT_Backstage] of the MS Custom UI XML specification which specifies a reference to the Backstage. | ||
| + | |||
| + | == Properties == | ||
| + | {{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | ||
| + | {{DocTableEntry | name=isEmpty}} | ||
| + | {{DocTableEntry | name=isLive}} | ||
| + | {{DocTableEntry | name=parent}} | ||
| + | {{DocTableEntry | name=startFromScratch}} | ||
| + | {{DocTableEntry | name=xml}} | ||
| + | {{DocTableEnd}} | ||
| + | |||
| + | == {{Collections Section Title}} == | ||
| + | {{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | ||
| + | {{DocTableColEntry | controlName=rxBackstage| propName=buttons}} | ||
| + | {{DocTableColEntry | controlName=rxBackstage| propName=tabs}} | ||
| + | {{DocTableEntry | name=ribbonXControls}} | ||
| + | {{DocTableColEntry | controlName=rxBackstage| propName=tabs}} | ||
| + | {{DocTableEnd}} | ||
| + | |||
| + | == Methods == | ||
| + | {{DocTableBegin | Col1Name=Method Name | Col2Name=Description}} | ||
| + | {{DocTableEntry | name=clear}} | ||
| + | {{DocTableEntry | name=clone}} | ||
| + | {{DocTableEntry | name=readXml}} | ||
| + | {{DocTableEnd}} | ||
| + | |||
| + | == Delegates == | ||
| + | {{DocTableBegin | Col1Name=Delegate Name | Col2Name=Description}} | ||
| + | {{DocTableEntry | name=onHide}} | ||
| + | {{DocTableEntry | name=onShow}} | ||
| + | {{DocTableEnd}} | ||
| + | |||
| + | == Events == | ||
| + | {{DocTableBegin | Col1Name=Event Name | Col2Name=Description}} | ||
| + | {{DocTableEntry | name=OnHideEvent}} | ||
| + | {{DocTableEntry | name=OnShowEvent}} | ||
| + | {{DocTableEnd}} | ||
| + | |||
| + | == Remarks == | ||
| + | |||
| + | == Examples == | ||
| + | |||
| + | === VBA === | ||
| + | <syntaxhighlight lang="vb" line> | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | === C# === | ||
| + | <syntaxhighlight lang="csharp" line> | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | === VB.NET === | ||
| + | <syntaxhighlight lang="vb" line> | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | === C++ === | ||
| + | <syntaxhighlight lang="cpp" line> | ||
| + | </syntaxhighlight> | ||
Revision as of 22:12, 12 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 |
| tabs | A collection of tabs |
| 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 |
