Difference between revisions of "RxMenuRoot"

From Ribbon Commander Documentation
Jump to: navigation, search
({{Collections Section Title}})
 
(One intermediate revision by the same user not shown)
Line 9: Line 9:
 
== Properties ==
 
== Properties ==
 
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
 
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
{{DocTableEntry | name=description}}
 
{{DocTableEntry | name=enabled}}
 
{{DocTableEntry | name=id}}
 
{{DocTableEntry | name=idMso}}
 
{{DocTableEntry | name=idQ}}
 
{{DocTableEntry | name=image}}
 
{{DocTableEntry | name=imageMso}}
 
{{DocTableEntry | name=insertAfterMso}}
 
{{DocTableEntry | name=insertAfterQ}}
 
{{DocTableEntry | name=insertBeforeMso}}
 
{{DocTableEntry | name=insertBeforeQ}}
 
 
{{DocTableEntry | name=isEmpty}}
 
{{DocTableEntry | name=isEmpty}}
 
{{DocTableEntry | name=isLive}}
 
{{DocTableEntry | name=isLive}}
 
{{DocTableEntry | name=itemSize}}
 
{{DocTableEntry | name=itemSize}}
{{DocTableEntry | name=keytip}}
 
{{DocTableEntry | name=label}}
 
 
{{DocTableEntry | name=parent}}
 
{{DocTableEntry | name=parent}}
{{DocTableEntry | name=screentip}}
+
{{DocTableEntry | name=title}}
{{DocTableEntry | name=showImage}}
+
{{DocTableEntry | name=showLabel}}
+
{{DocTableEntry | name=size}}
+
{{DocTableEntry | name=supertip}}
+
{{DocTableEntry | name=tag}}
+
{{DocTableEntry | name=visible}}
+
 
{{DocTableEntry | name=xml}}
 
{{DocTableEntry | name=xml}}
 
{{DocTableEnd}}
 
{{DocTableEnd}}
Line 38: Line 19:
 
== {{Collections Section Title}} ==
 
== {{Collections Section Title}} ==
 
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
 
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
{{DocTableColEntry | controlName=rxGroup| propName=buttons}}
+
{{DocTableColEntry | controlName=rxMenuRoot| propName=buttons}}
{{DocTableColEntry | controlName=rxGroup| propName=checkBoxes}}
+
{{DocTableColEntry | controlName=rxMenuRoot| propName=checkBoxes}}
{{DocTableColEntry | controlName=rxGroup| propName=controls}}
+
{{DocTableColEntry | controlName=rxMenuRoot| propName=controls}}
{{DocTableColEntry | controlName=rxGroup| propName=dynamicMenus}}
+
{{DocTableColEntry | controlName=rxMenuRoot| propName=dynamicMenus}}
{{DocTableColEntry | controlName=rxGroup| propName=galleries}}
+
{{DocTableColEntry | controlName=rxMenuRoot| propName=galleries}}
{{DocTableColEntry | controlName=rxGroup| propName=menus}}
+
{{DocTableColEntry | controlName=rxMenuRoot| propName=menus}}
{{DocTableColEntry | controlName=rxGroup| propName=menuSeparators}}
+
{{DocTableColEntry | controlName=rxMenuRoot| propName=menuSeparators}}
 +
{{DocTableColEntry | controlName=rxMenuRoot| propName=namespaces}}
 
{{DocTableEntry | name=ribbonXControls}}
 
{{DocTableEntry | name=ribbonXControls}}
{{DocTableColEntry | controlName=rxGroup| propName=splitButtons}}
+
{{DocTableColEntry | controlName=rxMenuRoot| propName=splitButtons}}
{{DocTableColEntry | controlName=rxGroup| propName=toggleButtons}}
+
{{DocTableColEntry | controlName=rxMenuRoot| propName=toggleButtons}}
 
{{DocTableEnd}}
 
{{DocTableEnd}}
  
Line 59: Line 41:
 
== Delegates ==
 
== Delegates ==
 
{{DocTableBegin | Col1Name=Delegate Name | Col2Name=Description}}
 
{{DocTableBegin | Col1Name=Delegate Name | Col2Name=Description}}
{{DocTableEntry | name=getDescription}}
 
{{DocTableEntry | name=getEnabled}}
 
{{DocTableEntry | name=getImage}}
 
{{DocTableEntry | name=getKeytip}}
 
{{DocTableEntry | name=getLabel}}
 
{{DocTableEntry | name=getScreentip}}
 
{{DocTableEntry | name=getShowImage}}
 
{{DocTableEntry | name=getShowLabel}}
 
{{DocTableEntry | name=getSize}}
 
{{DocTableEntry | name=getSupertip}}
 
{{DocTableEntry | name=getVisible}}
 
 
{{DocTableEnd}}
 
{{DocTableEnd}}
  
 
== Events ==
 
== Events ==
 
{{DocTableBegin | Col1Name=Event Name | Col2Name=Description}}
 
{{DocTableBegin | Col1Name=Event Name | Col2Name=Description}}
{{DocTableEntry | name=OnGetDescription}}
 
{{DocTableEntry | name=OnGetEnabled}}
 
{{DocTableEntry | name=OnGetImage}}
 
{{DocTableEntry | name=OnGetKeytip}}
 
{{DocTableEntry | name=OnGetLabel}}
 
{{DocTableEntry | name=OnGetScreentip}}
 
{{DocTableEntry | name=OnGetShowImage}}
 
{{DocTableEntry | name=OnGetShowLabel}}
 
{{DocTableEntry | name=OnGetSize}}
 
{{DocTableEntry | name=OnGetSupertip}}
 
{{DocTableEntry | name=OnGetVisible}}
 
 
{{DocTableEnd}}
 
{{DocTableEnd}}
  

Latest revision as of 13:09, 13 March 2013

RxMenuRoot.png

Description

rxMenuRoot models element CT_MenuRoot of the MS Custom UI XML specification which specifies the root tag of the XML string returned by a dynamic menu control.

Properties

Property Name
Description
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
parent The control's parent object
title The control's title
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
namespaces The collection of XML namespaces used in the control's context
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

Events

Event Name
Description

Remarks

Examples

VBA

  1.  

C#

  1.  

VB.NET

  1.  

C++

  1.