rxBackstageLabelControl
From Ribbon Commander Documentation
Contents
Description
rxBackstageLabelControl models element CT_BackstageLabelControl of the MS Custom UI XML specification which specifies a Backstage control that displays a simple string of text.
Properties
Property Name
|
Description
|
alignLabel | Specifies the position where the controlâÂÂs label is aligned |
enabled | Whether the controls is enabled |
expand | Specifies the directions in which the control expands to fill its parent container. |
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 |
isEmpty | Read-only property; returns true if the control is empty |
isLive | Read-only property; returns true if the control is live |
label | Sets the control's label |
noWrap | If true, text isn't automatically wrapped to appear in several lines if its length exceeds the control's visible client area |
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
|
getEnabled | Callback that sets the control's enabled state |
getLabel | Callback that sets the label |
getVisible | Callback that sets the control's visible state |
Events
Event Name
|
Description
|
OnGetEnabled | Callback that sets the control's enabled state |
OnGetLabel | Callback that sets the label |
OnGetVisible | Callback that sets the control's visible state |