Difference between revisions of "RxCommand"
From Ribbon Commander Documentation
(→Events) |
|||
| (2 intermediate revisions by the same user not shown) | |||
| 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}} | ||
| Line 39: | Line 26: | ||
== Delegates == | == Delegates == | ||
{{DocTableBegin | Col1Name=Delegate Name | Col2Name=Description}} | {{DocTableBegin | Col1Name=Delegate Name | Col2Name=Description}} | ||
| − | |||
{{DocTableEntry | name=getEnabled}} | {{DocTableEntry | name=getEnabled}} | ||
| − | {{DocTableEntry | name= | + | {{DocTableEntry | name=onAction_repurposed}} |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
{{DocTableEnd}} | {{DocTableEnd}} | ||
== Events == | == Events == | ||
{{DocTableBegin | Col1Name=Event Name | Col2Name=Description}} | {{DocTableBegin | Col1Name=Event Name | Col2Name=Description}} | ||
| − | {{DocTableEntry | name= | + | {{DocTableEntry | name=OnActionEvent_repurposed}} |
| − | + | ||
{{DocTableEntry | name=OnGetEnabled}} | {{DocTableEntry | name=OnGetEnabled}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{{DocTableEnd}} | {{DocTableEnd}} | ||
Latest revision as of 14:23, 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
|
| getEnabled | Callback that sets the control's enabled 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 |
