Difference between revisions of "RxTaskFormGroupCategory"
From Ribbon Commander Documentation
| Line 11: | Line 11: | ||
== Properties == | == Properties == | ||
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | {{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | ||
| − | |||
| − | |||
{{DocTableEntry | name=id}} | {{DocTableEntry | name=id}} | ||
{{DocTableEntry | name=idMso}} | {{DocTableEntry | name=idMso}} | ||
{{DocTableEntry | name=idQ}} | {{DocTableEntry | name=idQ}} | ||
| + | {{DocTableEntry | name=insertAfterMso}} | ||
| + | {{DocTableEntry | name=insertAfterQ}} | ||
| + | {{DocTableEntry | name=insertBeforeMso}} | ||
| + | {{DocTableEntry | name=insertBeforeQ}} | ||
{{DocTableEntry | name=isEmpty}} | {{DocTableEntry | name=isEmpty}} | ||
{{DocTableEntry | name=isLive}} | {{DocTableEntry | name=isLive}} | ||
{{DocTableEntry | name=label}} | {{DocTableEntry | name=label}} | ||
{{DocTableEntry | name=parent}} | {{DocTableEntry | name=parent}} | ||
| − | |||
{{DocTableEntry | name=tag}} | {{DocTableEntry | name=tag}} | ||
{{DocTableEntry | name=visible}} | {{DocTableEntry | name=visible}} | ||
| Line 28: | Line 29: | ||
== {{Collections Section Title}} == | == {{Collections Section Title}} == | ||
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | {{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | ||
| − | {{DocTableColEntry | controlName=rxTaskFormGroupCategory| propName= | + | {{DocTableColEntry | controlName=rxTaskFormGroupCategory| propName=tasks}} |
{{DocTableEntry | name=ribbonXControls}} | {{DocTableEntry | name=ribbonXControls}} | ||
{{DocTableEnd}} | {{DocTableEnd}} | ||
| Line 41: | Line 42: | ||
== Delegates == | == Delegates == | ||
{{DocTableBegin | Col1Name=Delegate Name | Col2Name=Description}} | {{DocTableBegin | Col1Name=Delegate Name | Col2Name=Description}} | ||
| − | |||
{{DocTableEntry | name=getLabel}} | {{DocTableEntry | name=getLabel}} | ||
| − | |||
{{DocTableEntry | name=getVisible}} | {{DocTableEntry | name=getVisible}} | ||
{{DocTableEnd}} | {{DocTableEnd}} | ||
| Line 49: | Line 48: | ||
== Events == | == Events == | ||
{{DocTableBegin | Col1Name=Event Name | Col2Name=Description}} | {{DocTableBegin | Col1Name=Event Name | Col2Name=Description}} | ||
| − | |||
{{DocTableEntry | name=OnGetLabel}} | {{DocTableEntry | name=OnGetLabel}} | ||
| − | |||
{{DocTableEntry | name=OnGetVisible}} | {{DocTableEntry | name=OnGetVisible}} | ||
{{DocTableEnd}} | {{DocTableEnd}} | ||
Latest revision as of 12:06, 13 March 2013
Contents
Description
rxTaskFormGroupCategory models element CT_TaskFormGroupCategory of the MS Custom UI XML specification which specifies a grouping of child controls within a TaskGroup control.
Properties
Property Name
|
Description
|
| 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 |
| 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
|
| tasks | A collection of tasks |
| 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 |
| getVisible | Callback that sets the control's visible state |
Events
Event Name
|
Description
|
| OnGetLabel | Callback that sets the label |
| OnGetVisible | Callback that sets the control's visible state |
