Difference between revisions of "RxButton"

From Ribbon Commander Documentation
Jump to: navigation, search
(→‎Events)
(→‎Properties)
Line 12: Line 12:
 
|<div style="background-color:#3886c9; font-weight:bold; color:white; padding-left:10px; margin:1em 0; font-size:small; text-align:left">Description</div>
 
|<div style="background-color:#3886c9; font-weight:bold; color:white; padding-left:10px; margin:1em 0; font-size:small; text-align:left">Description</div>
 
|-
 
|-
−
| style="padding-left: 10px" | description || Sets the extended description of the control, which appears in menus with itemSize set to large
+
| style="padding-left: 10px" | {{Name_description}} || {{Desc_description}}
 
|-
 
|-
−
| style="padding-left: 10px" | enabled || Whether the controls is enabled
+
| style="padding-left: 10px" | {{Name_enabled}} || {{Desc_enabled}}
 
|-
 
|-
−
| style="padding-left: 10px" | id|| The ID of a custom UI element. IDs must be unique.
+
| style="padding-left: 10px" | {{Name_id}} || {{Desc_id}}
 
|-
 
|-
−
| style="padding-left: 10px" | idMso|| The ID of a built-in control.
+
| style="padding-left: 10px" | {{Name_idMso}} || {{Desc_idMso}}
 
|-
 
|-
−
| style="padding-left: 10px" | idQ|| A qualified control ID. Qualified IDs allow different add-ins to modify the same custom group, tab, or menu.
+
| style="padding-left: 10px" | {{Name_idQ}} || {{Desc_idQ}}
 
|-
 
|-
−
| style="padding-left: 10px" | image || A custom image or icon.
+
| style="padding-left: 10px" | {{Name_image}} || {{Desc_image}}
 
|-
 
|-
−
| style="padding-left: 10px" | imageMso || The image of a built-in control.
+
| style="padding-left: 10px" | {{Name_imageMso}} || {{Desc_imageMso}}
 
|-
 
|-
−
| style="padding-left: 10px" | insertAfterMso || The ID of a built-in control to be inserted after.
+
| style="padding-left: 10px" | {{Name_insertAfterMso}} || {{Desc_insertAfterMso}}
 
|-
 
|-
−
| style="padding-left: 10px" | insertAfterQ || The ID of a control to be inserted after.
+
| style="padding-left: 10px" | {{Name_insertAfterQ}} || {{Desc_insertAfterQ}}
 
|-
 
|-
−
| style="padding-left: 10px" | insertBeforeMso || The ID of a built-in control to be inserted before.
+
| style="padding-left: 10px" | {{Name_insertBeforeMso}} || {{Desc_insertBeforeMso}}
 
|-
 
|-
−
| style="padding-left: 10px" | insertBeforeQ || The ID of control to be inserted before.
+
| style="padding-left: 10px" | {{Name_insertBeforeQ}} || {{Desc_insertBeforeQ}}
 
|-
 
|-
−
| style="padding-left: 10px" | isEmpty || Read-only property; returns True if the control is empty
+
| style="padding-left: 10px" | {{Name_isEmpty}} || {{Desc_isEmpty}}
 
|-
 
|-
−
| style="padding-left: 10px" | isLive || Read-only property; returns True if the control is live
+
| style="padding-left: 10px" | {{Name_isLive}} || {{Desc_isLive}}
 
|-
 
|-
−
| style="padding-left: 10px" | keytip || Sets the keytip
+
| style="padding-left: 10px" | {{Name_keytip}} || {{Desc_keytip}}
 
|-
 
|-
−
| style="padding-left: 10px" | label || Sets the label.
+
| style="padding-left: 10px" | {{Name_label}} || {{Desc_label}}
 
|-
 
|-
−
| style="padding-left: 10px" | parent || The parent object
+
| style="padding-left: 10px" | {{Name_parent}} || {{Desc_parent}}
 
|-
 
|-
−
| style="padding-left: 10px" | screentip || Sets the screentip, which appears on mouse hover.
+
| style="padding-left: 10px" | {{Name_screentip}} || {{Desc_screentip}}
 
|-
 
|-
−
| style="padding-left: 10px" | showImage|| Whether to show a control's image.
+
| style="padding-left: 10px" | {{Name_showImage}} || {{Desc_showImage}}
 
|-
 
|-
−
| style="padding-left: 10px" | showLabel || Whether to show a control's label.
+
| style="padding-left: 10px" | {{Name_showLabel}} || {{Desc_showLabel}}
 
|-
 
|-
−
| style="padding-left: 10px" | size || The size of a control
+
| style="padding-left: 10px" | {{Name_size} || {{Desc_size}}
 
|-
 
|-
−
| style="padding-left: 10px" | supertip || Sets the supertip, a large screentip.
+
| style="padding-left: 10px" | {{Name_supertip}} || {{Desc_supertip}}
 
|-
 
|-
−
| style="padding-left: 10px" | tag || Custom data.
+
| style="padding-left: 10px" | {{Name_tag}} || {{Desc_tag}}
 
|-
 
|-
−
| style="padding-left: 10px" | visible || Whether the control is visible.
+
| style="padding-left: 10px" | {{Name_visible}} || {{Desc_visible}}
 
|-
 
|-
−
| style="padding-left: 10px" | xml || Returns the xml node that corresponds to the state of the control
+
| style="padding-left: 10px" | {{Name_xml}} || {{Desc_xml}}
 
|}
 
|}
 
<div style="clear:left"></div>
 
<div style="clear:left"></div>

Revision as of 12:08, 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
{{Name_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 state of the object
clone Creates a clone of this control (a new id is automatically created if applicable)
readXml Populates the RibbonX object 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 OnActionEvent description
OnGetDescription OnGetDescription description
OnGetEnabled OnGetEnabled description
OnGetImage __DESCR__
OnGetKeytip __DESCR__
OnGetLabel __DESCR__
OnGetScreentip __DESCR__
OnGetShowImage __DESCR__
OnGetShowLabel __DESCR__
OnGetSize __DESCR__
OnGetSupertip __DESCR__
OnGetVisible __DESCR__

Examples

VBA

Dim grp As rxGroup
Set grp = New rxGroup
 
Dim btn As rxButton
Set btn = New rxButton
 
grp.Buttons.Add btn

C#

VB.NET

C++

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