rxImageControl
From Ribbon Commander Documentation
Contents
Description
rxImageControl models element CT_ImageControl of the MS Custom UI XML specification which specifies a control that displays an image.
Properties
Property Name
|
Description
|
altText | Specifies the string that is displayed as the alternative text of this control |
enabled | Whether the controls is enabled |
id | The ID of a custom UI element. IDs must be unique |
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 |
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 |
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
|
getAltText | Callback that sets the control's alternative text |
getEnabled | Callback that sets the control's enabled state |
getImage | Callback for a custom image |
getVisible | Callback that sets the control's visible state |
Events
Event Name
|
Description
|
OnGetAltText | Callback that sets the control's alternative text |
OnGetEnabled | Callback that sets the control's enabled state |
OnGetImage | Callback for a custom image |
OnGetVisible | Callback that sets the control's visible state |