rxLabelControl

From Ribbon Commander Documentation
Jump to: navigation, search
RxLabelControl.png

Description

rxLabelControl models element CT_LabelControl of the MS Custom UI XML specification which specifies a control that displays a string of text.

Properties

Property Name
Description
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
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
label Sets the control's label
parent The control's parent object
screentip Sets the screentip, which appears on mouse hover
showLabel Whether to show a control's label
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
getEnabled Callback that sets the control's enabled state
getLabel Callback that sets the label
getScreentip Callback that sets the screentip
getShowLabel Callback for whether to show the control's label
getSupertip Callback that sets the supertip, a large screentip
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
OnGetScreentip Callback that sets the screentip
OnGetShowLabel Callback for whether to show the control's label
OnGetSupertip Callback that sets the supertip, a large screentip
OnGetVisible Callback that sets the control's visible state

Remarks

Examples

VBA

  1.  

C#

  1.  

VB.NET

  1.  

C++

  1.