Difference between revisions of "RxButton"
From Ribbon Commander Documentation
(→Properties) |
(→Properties) |
||
Line 16: | Line 16: | ||
| style="padding-left: 10px" | enabled || Whether the controls is enabled | | style="padding-left: 10px" | enabled || Whether the controls is enabled | ||
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | id|| The ID of a custom UI element. IDs must be unique. |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | idMso|| The ID of a built-in control. |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | 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" | | + | | style="padding-left: 10px" | image || A custom image or icon. |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | imageMso || The image of a built-in control. |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | insertAfterMso || The ID of a built-in control to be inserted after. |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | insertAfterQ || The ID of a control to be inserted after. |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | insertBeforeMso || The ID of a built-in control to be inserted before. |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | insertBeforeQ || The ID of control to be inserted before. |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | isEmpty || Read-only property; returns True if the control is empty |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | isLive || Read-only property; returns True if the control is live |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | keytip || Sets the keytip |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | label || Sets the label. |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | parent || The parent object |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | screentip || Sets the screentip, which appears on mouse hover. |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | showImage|| Whether to show a control's image. |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | showLabel || Whether to show a control's label. |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | size || The size of a control |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | supertip || Sets the supertip, a large screentip. |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | tag || Custom data. |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | visible || Whether the control is visible. |
|- | |- | ||
− | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | xml || Returns the xml node that corresponds to the state of the control |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|} | |} | ||
<div style="clear:left"></div> | <div style="clear:left"></div> |
Revision as of 11:48, 11 March 2013
Contents
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 keytip |
label | Sets the label. |
parent | The 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 size of a control |
supertip | Sets the 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 | clear description |
clone | clone description |
readXml | readXml description |
Delegates
Delegate Name
|
Description
|
onAction | onAction delegate description |
getDescription | getDescription description |
getEnabled | getEnabled description |
Events
Event Name
|
Description
|
OnActionEvent | OnActionEvent description |
OnGetDescription | OnGetDescription description |
OnGetEnabled | OnGetEnabled description |
Examples
VBA
Dim grp As rxGroup Set grp = New rxGroup Dim btn As rxButton Set btn = New rxButton grp.Buttons.Add btn