Difference between revisions of "RxBackstageFastCommandButton"
From Ribbon Commander Documentation
(→Properties) |
|||
| Line 9: | Line 9: | ||
== Properties == | == Properties == | ||
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | {{DocTableBegin | Col1Name=Property Name | Col2Name=Description}} | ||
| − | |||
{{DocTableEntry | name=enabled}} | {{DocTableEntry | name=enabled}} | ||
{{DocTableEntry | name=id}} | {{DocTableEntry | name=id}} | ||
| Line 20: | Line 19: | ||
{{DocTableEntry | name=insertBeforeMso}} | {{DocTableEntry | name=insertBeforeMso}} | ||
{{DocTableEntry | name=insertBeforeQ}} | {{DocTableEntry | name=insertBeforeQ}} | ||
| + | {{DocTableEntry | name=isDefinitive}} | ||
{{DocTableEntry | name=isEmpty}} | {{DocTableEntry | name=isEmpty}} | ||
{{DocTableEntry | name=isLive}} | {{DocTableEntry | name=isLive}} | ||
| Line 25: | Line 25: | ||
{{DocTableEntry | name=label}} | {{DocTableEntry | name=label}} | ||
{{DocTableEntry | name=parent}} | {{DocTableEntry | name=parent}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{{DocTableEntry | name=tag}} | {{DocTableEntry | name=tag}} | ||
{{DocTableEntry | name=visible}} | {{DocTableEntry | name=visible}} | ||
Latest revision as of 20:07, 11 March 2013
Contents
Description
rxBackstageFastCommandButton models element CT_BackstageFastCommandButton of the MS Custom UI XML specification which specifies a button that exists in the navigation pane of the Backstage.
Properties
Property Name
|
Description
|
| enabled | Whether the controls is enabled |
| 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 |
| image | A custom image or icon |
| imageMso | The image of a built-in control |
| 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 |
| isDefinitive | Whether the backstage view is closed after the control is actioned |
| 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 |
| tag | Custom data |
| visible | Whether the control is visible |
| xml | Returns the xml node that corresponds to the state of the control |
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 |
| getImage | Callback for a custom image |
| getKeytip | Callback that sets the keytip |
| getLabel | Callback that sets the label |
| 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 |
| OnGetImage | Callback for a custom image |
| OnGetKeytip | Callback that sets the keytip |
| OnGetLabel | Callback that sets the label |
| OnGetVisible | Callback that sets the control's visible state |
