Difference between revisions of "RxButton"
From Ribbon Commander Documentation
(→Delegates) |
|||
| Line 80: | Line 80: | ||
|<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" | | + | | style="padding-left: 10px" | {{Name_getDescription}} || {{Desc_getDescription}} |
|- | |- | ||
| − | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | {{Name_getEnabled}} || {{Desc_getEnabled}} |
|- | |- | ||
| − | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | {{Name_getImage}} || {{Desc_getImage}} |
|- | |- | ||
| − | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | {{Name_getKeytip}} || {{Desc_getKeytip}} |
|- | |- | ||
| − | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | {{Name_getLabel}} || {{Desc_getLabel}} |
|- | |- | ||
| − | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | {{Name_getScreentip}} || {{Desc_getScreentip}} |
|- | |- | ||
| − | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | {{Name_getShowImage}} || {{Desc_getShowImage}} |
|- | |- | ||
| − | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | {{Name_getShowLabel}} || {{Desc_getShowLabel}} |
|- | |- | ||
| − | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | {{Name_getSize}} || {{Desc_getSize}} |
|- | |- | ||
| − | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | {{Name_getSupertip}} || {{Desc_getSupertip}} |
|- | |- | ||
| − | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | {{Name_getVisible}} || {{Desc_getVisible}} |
|- | |- | ||
| − | | style="padding-left: 10px" | | + | | style="padding-left: 10px" | {{Name_onAction_button}} || {{Desc_onAction_button}} |
|} | |} | ||
<div style="clear:left"></div> | <div style="clear:left"></div> | ||
Revision as of 12:26, 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 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 | 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
