Difference between revisions of "RxBackstageGroup"
From Ribbon Commander Documentation
(Created page with "{{DISPLAYTITLE:rxBackstageGroup}} Category:Controls Category:2010 Controls") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:rxBackstageGroup}} | {{DISPLAYTITLE:rxBackstageGroup}} | ||
| − | [[ | + | [[Category:Controls]] |
| − | [[ | + | [[Category:2010 Controls]] |
| + | |||
| + | [[image: rxBackstageGroup.png|right|link=]] | ||
| + | == Description == | ||
| + | rxBackstageGroup models element [http://msdn.microsoft.com/en-us/library/dd951562(v=office.12).aspx CT_BackstageGroup] of the MS Custom UI XML specification which specifies a Backstage group control. | ||
| + | |||
| + | == Properties == | ||
| + | {{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | ||
| + | {{DocTableEntry | name=helperText}} | ||
| + | {{DocTableEntry | name=id}} | ||
| + | {{DocTableEntry | name=idMso}} | ||
| + | {{DocTableEntry | name=idQ}} | ||
| + | {{DocTableEntry | name=insertAfterMso}} | ||
| + | {{DocTableEntry | name=insertAfterQ}} | ||
| + | {{DocTableEntry | name=insertBeforeMso}} | ||
| + | {{DocTableEntry | name=insertBeforeQ}} | ||
| + | {{DocTableEntry | name=isEmpty}} | ||
| + | {{DocTableEntry | name=isLive}} | ||
| + | {{DocTableEntry | name=label}} | ||
| + | {{DocTableEntry | name=parent}} | ||
| + | {{DocTableEntry | name=showLabel}} | ||
| + | {{DocTableEntry | name=style}} | ||
| + | {{DocTableEntry | name=tag}} | ||
| + | {{DocTableEntry | name=visible}} | ||
| + | {{DocTableEntry | name=xml}} | ||
| + | {{DocTableEnd}} | ||
| + | |||
| + | == {{Collections Section Title}} == | ||
| + | {{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | ||
| + | {{DocTableColEntry | controlName=rxBackstageGroup | propName=bottomItems}} | ||
| + | {{DocTableColEntry | controlName=rxBackstageGroup | propName=primaryItem}} | ||
| + | {{DocTableColEntry | controlName=rxBackstageGroup | propName=topItems}} | ||
| + | {{DocTableEntry | name=ribbonXControls}} | ||
| + | {{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=getHelperText}} | ||
| + | {{DocTableEntry | name=getLabel}} | ||
| + | {{DocTableEntry | name=getShowLabel}} | ||
| + | {{DocTableEntry | name=getStyle}} | ||
| + | {{DocTableEntry | name=getVisible}} | ||
| + | {{DocTableEnd}} | ||
| + | |||
| + | == Events == | ||
| + | {{DocTableBegin | Col1Name=Event Name | Col2Name=Description}} | ||
| + | {{DocTableEntry | name=OnGetHelperText}} | ||
| + | {{DocTableEntry | name=OnGetLabel}} | ||
| + | {{DocTableEntry | name=OnGetShowLabel}} | ||
| + | {{DocTableEntry | name=OnGetStyle}} | ||
| + | {{DocTableEntry | name=OnGetVisible}} | ||
| + | {{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 00:47, 13 March 2013
Contents
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 |
