rxComboBox
From Ribbon Commander Documentation
Revision as of 17:15, 12 March 2013 by Rxdff15551 bb53 (Talk | contribs)
Contents
Description
rxComboBox models element CT_ComboBox of the MS Custom UI XML specification which specifies a standard combo box control.
Properties
Property Name
|
Description
|
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 |
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 |
parent | The control's parent object |
visible | Whether the control is visible |
xml | Returns the xml node that corresponds to the state of the control |
Collections
Property Name
|
Description
|
buttons | A collection of buttons |
controls | A collection of controls that can enable, disable or clone built-in controls |
dynamicMenus | A collection of dynamic menus |
galleries | A collection of galleries |
menus | A collection of menus |
ribbonXControls | The collection of all contained ribbonX controls |
splitButtons | A collection of split-buttons |
toggleButtons | A collection of toggle-buttons |
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 |
getImage | Callback for a custom image |
getKeytip | Callback that sets the keytip |
getLabel | Callback that sets the label |
getScreentip | Callback that sets the screentip |
getShowImage | Callback for whether to show the control's image |
getShowLabel | Callback for whether to show the control's label |
getSupertip | Callback that sets the supertip, a large screentip |
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 |
OnGetImage | Callback for a custom image |
OnGetKeytip | Callback that sets the keytip |
OnGetLabel | Callback that sets the label |
OnGetScreentip | Callback that sets the screentip |
OnGetShowImage | Callback for whether to show the control's image |
OnGetShowLabel | Callback for whether to show the control's label |
OnGetSupertip | Callback that sets the supertip, a large screentip |
OnGetText | Callback that sets the control's initial text |
OnGetVisible | Callback that sets the control's visible state |