Difference between revisions of "RxMenuRoot"
From Ribbon Commander Documentation
(→{{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=isEmpty}} | {{DocTableEntry | name=isEmpty}} | ||
{{DocTableEntry | name=isLive}} | {{DocTableEntry | name=isLive}} | ||
{{DocTableEntry | name=itemSize}} | {{DocTableEntry | name=itemSize}} | ||
− | |||
− | |||
{{DocTableEntry | name=parent}} | {{DocTableEntry | name=parent}} | ||
− | {{DocTableEntry | name= | + | {{DocTableEntry | name=title}} |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
{{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= | + | {{DocTableColEntry | controlName=rxMenuRoot| propName=buttons}} |
− | {{DocTableColEntry | controlName= | + | {{DocTableColEntry | controlName=rxMenuRoot| propName=checkBoxes}} |
− | {{DocTableColEntry | controlName= | + | {{DocTableColEntry | controlName=rxMenuRoot| propName=controls}} |
− | {{DocTableColEntry | controlName= | + | {{DocTableColEntry | controlName=rxMenuRoot| propName=dynamicMenus}} |
− | {{DocTableColEntry | controlName= | + | {{DocTableColEntry | controlName=rxMenuRoot| propName=galleries}} |
− | {{DocTableColEntry | controlName= | + | {{DocTableColEntry | controlName=rxMenuRoot| propName=menus}} |
− | {{DocTableColEntry | controlName= | + | {{DocTableColEntry | controlName=rxMenuRoot| propName=menuSeparators}} |
+ | {{DocTableColEntry | controlName=rxMenuRoot| propName=namespaces}} | ||
{{DocTableEntry | name=ribbonXControls}} | {{DocTableEntry | name=ribbonXControls}} | ||
− | {{DocTableColEntry | controlName= | + | {{DocTableColEntry | controlName=rxMenuRoot| propName=splitButtons}} |
− | {{DocTableColEntry | controlName= | + | {{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}} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
{{DocTableEnd}} | {{DocTableEnd}} | ||
== Events == | == Events == | ||
{{DocTableBegin | Col1Name=Event Name | Col2Name=Description}} | {{DocTableBegin | Col1Name=Event Name | Col2Name=Description}} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
{{DocTableEnd}} | {{DocTableEnd}} | ||
Latest revision as of 13:09, 13 March 2013
Contents
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
|