Difference between revisions of "RxBackstageMenuGroup"
From Ribbon Commander Documentation
(Created page with "{{DISPLAYTITLE:rxBackstageMenuGroup}} Category:Controls Category:2010 Controls") |
(→{{Collections Section Title}}) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:rxBackstageMenuGroup}} | {{DISPLAYTITLE:rxBackstageMenuGroup}} | ||
| − | [[ | + | [[Category:Controls]] |
| − | [[ | + | [[Category:2010 Controls]] |
| + | |||
| + | [[image: rxBackstageMenuGroup.png|right|link=]] | ||
| + | == Description == | ||
| + | rxBackstageMenuGroup models element [http://msdn.microsoft.com/en-us/library/dd923809(v=office.12).aspx CT_BackstageMenuGroup] of the MS Custom UI XML specification which specifies a grouping of controls within a Backstage menu control. | ||
| + | |||
| + | == Properties == | ||
| + | {{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | ||
| + | {{DocTableEntry | name=id}} | ||
| + | {{DocTableEntry | name=idQ}} | ||
| + | {{DocTableEntry | name=isEmpty}} | ||
| + | {{DocTableEntry | name=isLive}} | ||
| + | {{DocTableEntry | name=itemSize}} | ||
| + | {{DocTableEntry | name=label}} | ||
| + | {{DocTableEntry | name=parent}} | ||
| + | {{DocTableEntry | name=tag}} | ||
| + | {{DocTableEntry | name=xml}} | ||
| + | {{DocTableEnd}} | ||
| + | |||
| + | == {{Collections Section Title}} == | ||
| + | {{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | ||
| + | {{DocTableColEntry | controlName=rxBackstageMenuGroup| propName=buttons}} | ||
| + | {{DocTableColEntry | controlName=rxBackstageMenuGroup| propName=checkBoxes}} | ||
| + | {{DocTableColEntry | controlName=rxBackstageMenuGroup| propName=menus}} | ||
| + | {{DocTableEntry | name=ribbonXControls}} | ||
| + | {{DocTableColEntry | controlName=rxBackstageMenuGroup| propName=toggleButtons}} | ||
| + | {{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=getLabel}} | ||
| + | {{DocTableEnd}} | ||
| + | |||
| + | == Events == | ||
| + | {{DocTableBegin | Col1Name=Event Name | Col2Name=Description}} | ||
| + | {{DocTableEntry | name=OnGetLabel}} | ||
| + | {{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> | ||
Latest revision as of 01:01, 13 March 2013
Contents
Description
rxBackstageMenuGroup models element CT_BackstageMenuGroup of the MS Custom UI XML specification which specifies a grouping of controls within a Backstage menu control.
Properties
Property Name
|
Description
|
| id | The ID of a custom UI element. IDs must be unique |
| idQ | A qualified control ID. Qualified IDs allow different add-ins to modify the same custom group, tab, or menu |
| isEmpty | Read-only property; returns true if the control is empty |
| isLive | Read-only property; returns true if the control is live |
| itemSize | Size of menu items |
| label | Sets the control's label |
| parent | The control's parent object |
| tag | Custom data |
| xml | Returns the xml node that corresponds to the state of the control |
Contained Controls
Property Name
|
Description
|
| buttons | A collection of buttons |
| checkBoxes | A collection of check boxes |
| menus | A collection of menus |
| ribbonXControls | The collection of all contained ribbonX controls |
| toggleButtons | A collection of toggle-buttons |
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
|
| getLabel | Callback that sets the label |
Events
Event Name
|
Description
|
| OnGetLabel | Callback that sets the label |
