rxBackstageRegularButton

Description

rxBackstageRegularButton models element CT_BackstageRegularButton of the MS Custom UI XML specification which specifies a Backstage button control.

Properties

Property Name	Description
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
isDefinitive	Whether the backstage view is closed after the control is actioned
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
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
getImage	Callback for a custom image
getKeytip	Callback that sets the keytip
getLabel	Callback that sets the label
getScreentip	Callback that sets the screentip
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	Callback fired on user action
OnGetEnabled	Callback that sets the control's enabled state
OnGetImage	Callback for a custom image
OnGetKeytip	Callback that sets the keytip
OnGetLabel	Callback that sets the label
OnGetScreentip	Callback that sets the screentip
OnGetSupertip	Callback that sets the supertip, a large screentip
OnGetVisible	Callback that sets the control's visible state