Difference between revisions of "RxGroupControls"
From Ribbon Commander Documentation
(Created page with "{{DISPLAYTITLE:rxGroupControls}} Category:Controls Category:2010 Controls") |
|||
| Line 2: | Line 2: | ||
[[Category:Controls]] | [[Category:Controls]] | ||
[[Category:2010 Controls]] | [[Category:2010 Controls]] | ||
| + | |||
| + | [[image: rxGroupControls.png|right|link=]] | ||
| + | == Description == | ||
| + | rxGroupControls models element [http://msdn.microsoft.com/en-us/library/dd926924(v=office.12).aspx CT_GroupControls] of the MS Custom UI XML specification which specifies a grouping container that visually groups child controls together. | ||
| + | |||
| + | == Properties == | ||
| + | {{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | ||
| + | {{DocTableEntry | name=expand}} | ||
| + | {{DocTableEntry | name=id}} | ||
| + | {{DocTableEntry | name=idQ}} | ||
| + | {{DocTableEntry | name=isEmpty}} | ||
| + | {{DocTableEntry | name=isLive}} | ||
| + | {{DocTableEntry | name=label}} | ||
| + | {{DocTableEntry | name=parent}} | ||
| + | {{DocTableEntry | name=tag}} | ||
| + | {{DocTableEntry | name=xml}} | ||
| + | {{DocTableEnd}} | ||
| + | |||
| + | == {{Collections Section Title}} == | ||
| + | {{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | ||
| + | {{DocTableColEntry | controlName=rxGroupControls| propName=buttons}} | ||
| + | {{DocTableColEntry | controlName=rxGroupControls| propName=checkBoxes}} | ||
| + | {{DocTableColEntry | controlName=rxGroupControls| propName=comboBoxes}} | ||
| + | {{DocTableColEntry | controlName=rxGroupControls| propName=dropDowns}} | ||
| + | {{DocTableColEntry | controlName=rxGroupControls| propName=editBoxes}} | ||
| + | {{DocTableColEntry | controlName=rxGroupControls| propName=groupBoxes}} | ||
| + | {{DocTableColEntry | controlName=rxGroupControls| propName=hyperlinks}} | ||
| + | {{DocTableColEntry | controlName=rxGroupControls| propName=imageControls}} | ||
| + | {{DocTableColEntry | controlName=rxGroupControls| propName=labelControls}} | ||
| + | {{DocTableColEntry | controlName=rxGroupControls| propName=layoutContainers}} | ||
| + | {{DocTableColEntry | controlName=rxGroupControls| propName=radioGroups}} | ||
| + | {{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=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> | ||
Revision as of 02:45, 13 March 2013
Contents
Description
rxGroupControls models element CT_GroupControls of the MS Custom UI XML specification which specifies a grouping container that visually groups child controls together.
Properties
Property Name
|
Description
|
| expand | Specifies the directions in which the control expands to fill its parent container. |
| 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 |
| 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 |
| comboBoxes | A collection of combo boxes |
| dropDowns | A collection of drop-downs |
| editBoxes | A collection of edit boxes |
| groupBoxes | A collection of group boxes |
| hyperlinks | A collection of hyperlinks |
| imageControls | A collection of image controls |
| labelControls | A collection of label controls |
| layoutContainers | A collection of layout containers |
| radioGroups | A collection of radio group controls |
| 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
|
| getLabel | Callback that sets the label |
Events
Event Name
|
Description
|
| OnGetLabel | Callback that sets the label |
