rxMenuRegular

Description

rxMenuRegular models element CT_MenuRegular of the MS Custom UI XML specification which specifies a menu control that is of fixed size because of its location.

Properties

Property Name	Description
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
isEmpty	Read-only property; returns true if the control is empty
isLive	Read-only property; returns true if the control is live
itemSize	Size of menu items
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
showImage	Whether to show a control's image
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

Contained Controls

Property Name	Description
buttons	A collection of buttons
checkBoxes	A collection of check boxes
controls	A collection of controls that can enable, disable or clone built-in controls
dynamicMenus	A collection of dynamic menus
galleries	A collection of galleries
menus	A collection of menus
menuSeparators	A collection of menu separators
ribbonXControls	The collection of all contained ribbonX controls
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
getDescription	Callback that sets the control's 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
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

Events

Event Name	Description
OnGetDescription	Callback that sets the control's description
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
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