rxBackstageMenuGroup

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

Description

rxBackstageMenuGroup models element CT_BackstageMenuGroup of the MS Custom UI XML specification which specifies a grouping of controls within a Backstage menu control.

Properties

Property Name
Description
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
itemSize Size of menu items
label Sets the control's label
parent The control's parent object
tag Custom data
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
menus A collection of menus
ribbonXControls The collection of all contained ribbonX controls
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
getLabel Callback that sets the label

Events

Event Name
Description
OnGetLabel Callback that sets the label

Remarks

Examples

VBA

  1.  

C#

  1.  

VB.NET

  1.  

C++

  1.