rxTaskFormGroup
From Ribbon Commander Documentation
Revision as of 11:58, 13 March 2013 by Rxdff15551 bb53 (Talk | contribs)
Contents
Description
rxTaskFormGroup models element CT_TaskFormGroup of the MS Custom UI XML specification which specifies a list of Backstage group controls.
Properties
Property Name
|
Description
|
allowedTaskSizes | Specifies the allowed sizes for tasks within this control |
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 |
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 |
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
|
categories | A collection of categories |
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 |
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 |
OnGetVisible | Callback that sets the control's visible state |