Difference between revisions of "RxCommand"
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=idMso}} | {{DocTableEntry | name=idMso}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{{DocTableEntry | name=isEmpty}} | {{DocTableEntry | name=isEmpty}} | ||
{{DocTableEntry | name=isLive}} | {{DocTableEntry | name=isLive}} | ||
| − | |||
| − | |||
{{DocTableEntry | name=parent}} | {{DocTableEntry | name=parent}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
{{DocTableEntry | name=xml}} | {{DocTableEntry | name=xml}} | ||
{{DocTableEnd}} | {{DocTableEnd}} | ||
Revision as of 14:21, 11 March 2013
Contents
Description
rxCommand models element CT_Command of the MS Custom UI XML specification which specifies a built-in command for which the functionality will be repurposed
Properties
Property Name
|
Description
|
| enabled | Whether the controls is enabled |
| idMso | The ID of a built-in control |
| 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 |
| 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
|
| getDescription | Callback that sets the control's description |
| getEnabled | Callback that sets the control's enabled state |
| getKeytip | Callback that sets the keytip |
| getLabel | Callback that sets the label |
| getPressed | Callback that determines whether the control is in the 'pressed' state when first rendered/invalidated |
| getScreentip | Callback that sets the screentip |
| 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 |
| OnGetDescription | Callback that sets the control's description |
| OnGetEnabled | Callback that sets the control's enabled state |
| OnGetKeytip | Callback that sets the keytip |
| OnGetLabel | Callback that sets the label |
| OnGetPressed | Callback that determines whether the control is in the 'pressed' state when first rendered/invalidated |
| OnGetScreentip | Callback that sets the screentip |
| OnGetSupertip | Callback that sets the supertip, a large screentip |
| OnGetVisible | Callback that sets the control's visible state |
