Difference between revisions of "RxBackstageDropDown"
From Ribbon Commander Documentation
(→Events) |
|||
| Line 59: | Line 59: | ||
{{DocTableEntry | name=OnGetLabel}} | {{DocTableEntry | name=OnGetLabel}} | ||
{{DocTableEntry | name=OnGetScreentip}} | {{DocTableEntry | name=OnGetScreentip}} | ||
| − | {{DocTableEntry | name= | + | {{DocTableEntry | name=OnGetSelectedItemIndex}} |
{{DocTableEntry | name=OnGetSupertip}} | {{DocTableEntry | name=OnGetSupertip}} | ||
{{DocTableEntry | name=OnGetVisible}} | {{DocTableEntry | name=OnGetVisible}} | ||
{{DocTableEnd}} | {{DocTableEnd}} | ||
| − | |||
== Remarks == | == Remarks == | ||
Latest revision as of 00:40, 13 March 2013
Contents
Description
rxBackstageDropDown models element CT_BackstageDropDown of the MS Custom UI XML specification which specifies a Backstage drop-down control.
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 |
| screentip | Sets the screentip, which appears on mouse hover |
| sizeString | A representative string that sets the control's width |
| supertip | Sets the control's supertip, a large screentip |
| 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
|
| getEnabled | Callback that sets the control's enabled state |
| getKeytip | Callback that sets the keytip |
| getLabel | Callback that sets the label |
| getScreentip | Callback that sets the screentip |
| getSelectedItemIndex | Callback that specifies the index of the selected item when the control is created/invalidated |
| getSupertip | Callback that sets the supertip, a large screentip |
| getVisible | Callback that sets the control's visible state |
| onAction | Callback fired on user action |
Events
Event Name
|
Description
|
| OnActionEvent | Callback fired on user action |
| OnGetEnabled | Callback that sets the control's enabled state |
| OnGetKeytip | Callback that sets the keytip |
| OnGetLabel | Callback that sets the label |
| OnGetScreentip | Callback that sets the screentip |
| OnGetSelectedItemIndex | Callback that specifies the index of the selected item when the control is created/invalidated |
| OnGetSupertip | Callback that sets the supertip, a large screentip |
| OnGetVisible | Callback that sets the control's visible state |
