Difference between revisions of "RxCommand"

From Ribbon Commander Documentation
Jump to: navigation, search
(Created page with "{{DISPLAYTITLE:rxCommand}} Category:Controls Category:2007 Controls")
 
(Events)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:rxCommand}}
 
{{DISPLAYTITLE:rxCommand}}
[[:Category:Controls]]
+
[[Category:Controls]]
[[:Category:2007 Controls]]
+
[[Category:2007 Controls]]
 +
 
 +
[[image: rxCommand.png|310px|right|link=]]
 +
== Description ==
 +
rxCommand models element [http://msdn.microsoft.com/en-us/library/dd920756(v=office.12).aspx CT_Command] of the MS Custom UI XML specification which specifies a built-in command for which the functionality will be repurposed
 +
 
 +
== Properties ==
 +
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
 +
{{DocTableEntry | name=enabled}}
 +
{{DocTableEntry | name=idMso}}
 +
{{DocTableEntry | name=isEmpty}}
 +
{{DocTableEntry | name=isLive}}
 +
{{DocTableEntry | name=parent}}
 +
{{DocTableEntry | name=xml}}
 +
{{DocTableEnd}}
 +
 
 +
== Methods ==
 +
{{DocTableBegin | Col1Name=Method Name | Col2Name=Description}}
 +
{{DocTableEntry | name=clear}}
 +
{{DocTableEntry | name=clone}}
 +
{{DocTableEntry | name=readXml}}
 +
{{DocTableEnd}}
 +
 
 +
== Delegates ==
 +
{{DocTableBegin | Col1Name=Delegate Name | Col2Name=Description}}
 +
{{DocTableEntry | name=getEnabled}}
 +
{{DocTableEntry | name=onAction_repurposed}}
 +
{{DocTableEnd}}
 +
 
 +
== Events ==
 +
{{DocTableBegin | Col1Name=Event Name | Col2Name=Description}}
 +
{{DocTableEntry | name=OnActionEvent_repurposed}}
 +
{{DocTableEntry | name=OnGetEnabled}}
 +
{{DocTableEnd}}
 +
 
 +
== Remarks ==
 +
 
 +
== Examples ==
 +
 
 +
=== VBA ===
 +
<syntaxhighlight lang="vb" line>
 +
</syntaxhighlight>
 +
 
 +
=== C# ===
 +
<syntaxhighlight lang="csharp" line>
 +
</syntaxhighlight>
 +
 
 +
=== VB.NET ===
 +
<syntaxhighlight lang="vb" line>
 +
</syntaxhighlight>
 +
 
 +
=== C++ ===
 +
<syntaxhighlight lang="cpp" line>
 +
</syntaxhighlight>

Latest revision as of 14:23, 11 March 2013

RxCommand.png

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

Remarks

Examples

VBA

  1.  

C#

  1.  

VB.NET

  1.  

C++

  1.