rxBackstageEditBox

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

Description

rxBackstageEditBox models element CT_BackstageEditBox of the MS Custom UI XML specification which specifies a backstage edit box control.

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
keytip Sets the control's keytip
label Sets the control's label
maxLength The maximum number of characters the user may enter (must be in range [1,1024])
parent The control's parent object
sizeString A representative string that sets the control's width
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
onChange Callback that fires when the user changes the control's content
getEnabled Callback that sets the control's enabled state
getKeytip Callback that sets the keytip
getLabel Callback that sets the label
getText Callback that sets the control's initial text
getVisible Callback that sets the control's visible state

Events

Event Name
Description
OnChangeEvent Callback that fires when the user changes the control's content
OnGetEnabled Callback that sets the control's enabled state
OnGetKeytip Callback that sets the keytip
OnGetLabel Callback that sets the label
OnGetText Callback that sets the control's initial text
OnGetVisible Callback that sets the control's visible state

Remarks

Examples

VBA

  1.  

C#

  1.  

VB.NET

  1.  

C++

  1.