rxBackstageComboBox
From Ribbon Commander Documentation
Revision as of 00:33, 13 March 2013 by Rxdff15551 bb53 (Talk | contribs)
Contents
Description
rxBackstageComboBox models element CT_BackstageComboBox of the MS Custom UI XML specification which specifies a combo box control in the Backstage.
Properties
Property Name
|
Description
|
alignLabel | Specifies the position where the controlâÂÂs label is aligned |
enabled | Whether the controls is enabled |
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 |
keytip | Sets the control's keytip |
label | Sets the control's label |
parent | The control's parent object |
sizeString | A representative string that sets the control's width |
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
|
items | The collection of items in the drop-down |
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
|
onChange | Callback that fires when the user changes the control's content |
getEnabled | Callback that sets the control's enabled state |
getKeytip | Callback that sets the keytip |
getLabel | Callback that sets the label |
getText | Callback that sets the control's initial text |
getVisible | Callback that sets the control's visible state |
Events
Event Name
|
Description
|
OnChangeEvent | Callback that fires when the user changes the control's content |
OnGetEnabled | Callback that sets the control's enabled state |
OnGetKeytip | Callback that sets the keytip |
OnGetLabel | Callback that sets the label |
OnGetText | Callback that sets the control's initial text |
OnGetVisible | Callback that sets the control's visible state |