rxGroup

Description

rxGroup models element CT_Group of the MS Custom UI XML specification which specifies a grouping of controls within a ribbon tab.

Properties

Property Name	Description
autoScale	Whether the control's contents automatically resize as the size of the containing window changes
centerVertically	Whether the control's contents are centered vertically within the container
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
image	A custom image or icon
imageMso	The image of a built-in control
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
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

Contained Controls

Property Name	Description
boxes	A collection of boxes
buttonGroups	A collection of button groups
buttons	A collection of buttons
checkBoxes	A collection of check boxes
comboBoxes	A collection of combo boxes
controls	A collection of controls that can enable, disable or clone built-in controls
dialogLauncher	A dialog-launching control
dropDowns	A collection of drop-downs
dynamicMenus	A collection of dynamic menus
editBoxes	A collection of edit boxes
galleries	A collection of galleries
labelControls	A collection of label controls
menus	A collection of menus
ribbonXControls	The collection of all contained ribbonX controls
separators	A collection of separators
splitButtons	A collection of split-buttons
toggleButtons	A collection of toggle-buttons

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
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

Events

Event Name	Description
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