rxBackstageMenuToggleButton

From Ribbon Commander Documentation
Revision as of 20:46, 11 March 2013 by Rxdff15551 bb53 (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
RxBackstageMenuToggleButton.png

Description

rxBackstageMenuToggleButton models element CT_BackstageMenuToggleButton of the MS Custom UI XML specification which specifies a Backstage toggle button control that exists within a menu.

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
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
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
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
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
getPressed Callback that determines whether the control is in the 'pressed' state when first rendered/invalidated
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
OnGetKeytip Callback that sets the keytip
OnGetLabel Callback that sets the label
OnGetPressed Callback that determines whether the control is in the 'pressed' state when first rendered/invalidated
OnGetVisible Callback that sets the control's visible state

Remarks

Examples

VBA

  1.  

C#

  1.  

VB.NET

  1.  

C++

  1.