Difference between revisions of "RxButton"

From Ribbon Commander Documentation
Jump to: navigation, search
(→‎Properties)
(→‎Examples)
 
(42 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
[[image: rxButton.png|right|link=]]
 
[[image: rxButton.png|right|link=]]
 
== Description ==
 
== Description ==
−
rxButton models element [http://msdn.microsoft.com/en-us/library/dd926418(v=office.12).aspx CT_Button] of the MS Custom UI XML specification
+
rxButton models element [http://msdn.microsoft.com/en-us/library/dd926418(v=office.12).aspx CT_Button] of the MS Custom UI XML specification which specifies a standard push button.
  
 
== Properties ==
 
== Properties ==
−
{| width=65% style="float:left; border:1px solid #5090C0; padding-bottom:1em; text-align:left;"
+
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
−
|<div style="background-color:#3886c9; font-weight:bold; color:white; padding-left:10px; margin:1em 0; font-size:medium; text-align:left">Property Name</div>
+
{{DocTableEntry | name=description}}
−
|<h3 style="background-color:#3886c9; font-weight:bold; color:white; padding-left:10px; margin:1em 0; font-size:inherit; text-align:left">Description</h3>
+
{{DocTableEntry | name=enabled}}
−
|-
+
{{DocTableEntry | name=id}}
−
| style="padding-left: 10px" | description || The control's description in detailed views
+
{{DocTableEntry | name=idMso}}
−
|-
+
{{DocTableEntry | name=idQ}}
−
| style="padding-left: 10px" | enabled || Whether the controls is enabled
+
{{DocTableEntry | name=image}}
−
|}
+
{{DocTableEntry | name=imageMso}}
−
<div style="clear:left"></div>
+
{{DocTableEntry | name=insertAfterMso}}
 +
{{DocTableEntry | name=insertAfterQ}}
 +
{{DocTableEntry | name=insertBeforeMso}}
 +
{{DocTableEntry | name=insertBeforeQ}}
 +
{{DocTableEntry | name=isEmpty}}
 +
{{DocTableEntry | name=isLive}}
 +
{{DocTableEntry | name=keytip}}
 +
{{DocTableEntry | name=label}}
 +
{{DocTableEntry | name=parent}}
 +
{{DocTableEntry | name=screentip}}
 +
{{DocTableEntry | name=showImage}}
 +
{{DocTableEntry | name=showLabel}}
 +
{{DocTableEntry | name=size}}
 +
{{DocTableEntry | name=supertip}}
 +
{{DocTableEntry | name=tag}}
 +
{{DocTableEntry | name=visible}}
 +
{{DocTableEntry | name=xml}}
 +
{{DocTableEnd}}
  
 
== Methods ==
 
== Methods ==
−
{| width=65% style="float:left; border:1px solid #5090C0; padding-bottom:1em; text-align:left;"
+
{{DocTableBegin | Col1Name=Method Name | Col2Name=Description}}
−
|<h3 style="background-color:#3886c9; font-weight:bold; color:white; padding-left:10px; margin:1em 0; font-size:inherit; text-align:left">Method Name</h3>
+
{{DocTableEntry | name=clear}}
−
|<h3 style="background-color:#3886c9; font-weight:bold; color:white; padding-left:10px; margin:1em 0; font-size:inherit; text-align:left">Description</h3>
+
{{DocTableEntry | name=clone}}
−
|-
+
{{DocTableEntry | name=readXml}}
−
| style="padding-left: 10px" | clear || clear description
+
{{DocTableEnd}}
−
|-
+
−
| style="padding-left: 10px" | clone || clone description
+
−
|-
+
−
| style="padding-left: 10px" | readXml || readXml description
+
−
|}
+
−
<div style="clear:left"></div>
+
−
 
+
  
 
== Delegates ==
 
== Delegates ==
−
{| width=65% style="float:left; border:1px solid #5090C0; padding-bottom:1em; text-align:left;"
+
{{DocTableBegin | Col1Name=Delegate Name | Col2Name=Description}}
−
|<h3 style="background-color:#3886c9; font-weight:bold; color:white; padding-left:10px; margin:1em 0; font-size:inherit; text-align:left">Event Name</h3>
+
{{DocTableEntry | name=getDescription}}
−
|<h3 style="background-color:#3886c9; font-weight:bold; color:white; padding-left:10px;; margin:1em 0; font-size:inherit; text-align:left">Description</h3>
+
{{DocTableEntry | name=getEnabled}}
−
|-
+
{{DocTableEntry | name=getImage}}
−
| style="padding-left: 10px" | onAction|| onAction delegate description
+
{{DocTableEntry | name=getKeytip}}
−
|-
+
{{DocTableEntry | name=getLabel}}
−
| style="padding-left: 10px" | getDescription || getDescription description
+
{{DocTableEntry | name=getScreentip}}
−
|-
+
{{DocTableEntry | name=getShowImage}}
−
| style="padding-left: 10px" | getEnabled || getEnabled description
+
{{DocTableEntry | name=getShowLabel}}
−
|}
+
{{DocTableEntry | name=getSize}}
−
<div style="clear:left"></div>
+
{{DocTableEntry | name=getSupertip}}
−
 
+
{{DocTableEntry | name=getVisible}}
 +
{{DocTableEntry | name=onAction_button}}
 +
{{DocTableEnd}}
  
 
== Events ==
 
== Events ==
−
{| width=65% style="float:left; border:1px solid #5090C0; padding-bottom:1em; text-align:left;"
+
{{DocTableBegin | Col1Name=Event Name | Col2Name=Description}}
−
|<h3 style="background-color:#3886c9; font-weight:bold; color:white; padding-left:10px; margin:1em 0; font-size:inherit; text-align:left">Event Name</h3>
+
{{DocTableEntry | name=OnActionEvent_button}}
−
|<h3 style="background-color:#3886c9; font-weight:bold; color:white; padding-left:10px; margin:1em 0; font-size:inherit; text-align:left">Description</h3>
+
{{DocTableEntry | name=OnGetDescription}}
−
|-
+
{{DocTableEntry | name=OnGetEnabled}}
−
| style="padding-left: 10px" | OnActionEvent || OnActionEvent description
+
{{DocTableEntry | name=OnGetImage}}
−
|-
+
{{DocTableEntry | name=OnGetKeytip}}
−
| style="padding-left: 10px" | OnGetDescription || OnGetDescription description
+
{{DocTableEntry | name=OnGetLabel}}
−
|-
+
{{DocTableEntry | name=OnGetScreentip}}
−
| style="padding-left: 10px" | OnGetEnabled || OnGetEnabled description
+
{{DocTableEntry | name=OnGetShowImage}}
−
|}
+
{{DocTableEntry | name=OnGetShowLabel}}
−
<div style="clear:left"></div>
+
{{DocTableEntry | name=OnGetSize}}
 +
{{DocTableEntry | name=OnGetSupertip}}
 +
{{DocTableEntry | name=OnGetVisible}}
 +
{{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:33, 11 March 2013

RxButton.png

Description

rxButton models element CT_Button of the MS Custom UI XML specification which specifies a standard push button.

Properties

Property Name
Description
description Sets the extended description of the control, which appears in menus with itemSize set to large
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
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
showImage Whether to show a control's image
showLabel Whether to show a control's label
size The control's size
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

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
getImage Callback for a custom image
getKeytip Callback that sets the keytip
getLabel Callback that sets the label
getScreentip Callback that sets the screentip
getShowImage Callback for whether to show the control's image
getShowLabel Callback for whether to show the control's label
getSize Callback for the control's size
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
OnGetImage Callback for a custom image
OnGetKeytip Callback that sets the keytip
OnGetLabel Callback that sets the label
OnGetScreentip Callback that sets the screentip
OnGetShowImage Callback for whether to show the control's image
OnGetShowLabel Callback for whether to show the control's label
OnGetSize Callback for the control's size
OnGetSupertip Callback that sets the supertip, a large screentip
OnGetVisible Callback that sets the control's visible state

Remarks

Examples

VBA

  1.  

C#

  1.  

VB.NET

  1.  

C++

  1.  
Retrieved from ‘https://documentation.ribboncommander.com/index.php?title=RxButton&oldid=818’