rxGalleryRegular

Description

rxGalleryRegular models element CT_GalleryRegular of the MS Custom UI XML specification which specifies a gallery control that is of fixed size because of its location.

Properties

Property Name	Description
columns	Number of columns the control's items are displayed in
description	Sets the extended description of the control, which appears in menus with itemSize set to large
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
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
invalidateContentOnDrop	Whether the control invalidates its contents every time the drop-down is opened
isEmpty	Read-only property; returns true if the control is empty
isLive	Read-only property; returns true if the control is live
itemHeight	The height of owned items in pixels
itemWidth	The width of owned items in pixels
keytip	Sets the control's keytip
label	Sets the control's label
parent	The control's parent object
rows	Number of rows the control's items are displayed in
screentip	Sets the screentip, which appears on mouse hover
showImage	Whether to show a control's image
showItemImage	Whether owned item images are shown
showItemLabel	Whether owned item labels are shown
showLabel	Whether to show a control's label
sizeString	A representative string that sets the control's width
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
buttons	A collection of buttons
items	The collection of items in the drop-down
ribbonXControls	The collection of all contained ribbonX controls

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
getDescription	Callback that sets the control's description
getEnabled	Callback that sets the control's enabled state
getImage	Callback for a custom image
getItemHeight	Callback that returns the height of the control's items
getItemWidth	Callback that returns the width of the control's items
getKeytip	Callback that sets the keytip
getLabel	Callback that sets the label
getScreentip	Callback that sets the screentip
getSelectedItemIndex	Callback that specifies the index of the selected item when the control is created/invalidated
getShowImage	Callback for whether to show the control's image
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
onAction	Callback fired on user action

Events

Event Name	Description
OnActionEvent	Callback fired on user action
OnGetDescription	Callback that sets the control's description
OnGetEnabled	Callback that sets the control's enabled state
OnGetImage	Callback for a custom image
OnGetItemHeight	Callback that returns the height of the control's items
OnGetItemWidth	Callback that returns the width of the control's items
OnGetKeytip	Callback that sets the keytip
OnGetLabel	Callback that sets the label
OnGetScreentip	Callback that sets the screentip
OnGetSelectedItemIndex	Callback that specifies the index of the selected item when the control is created/invalidated
OnGetShowImage	Callback for whether to show the control's image
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