Difference between revisions of "RxPrimaryItem"

From Ribbon Commander Documentation
Jump to: navigation, search
 
(One intermediate revision by the same user not shown)
Line 5: Line 5:
 
[[image: rxPrimaryItem.png|right|link=]]
 
[[image: rxPrimaryItem.png|right|link=]]
 
== Description ==
 
== Description ==
rxPrimaryItem models element [http://msdn.microsoft.com/en-us/library/dd926617(v=office.12).aspx CT_PrimaryItem] of the MS Custom UI XML specification which specifies a Backstage drop-down control.
+
rxPrimaryItem models element [http://msdn.microsoft.com/en-us/library/dd926617(v=office.12).aspx CT_PrimaryItem] of the MS Custom UI XML specification which specifies a container for the primary UI of the containing Backstage group control.
  
 
== Properties ==
 
== Properties ==
 
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
 
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
{{DocTableEntry | name=alignLabel}}
 
{{DocTableEntry | name=enabled}}
 
{{DocTableEntry | name=expand}}
 
{{DocTableEntry | name=id}}
 
{{DocTableEntry | name=idQ}}
 
 
{{DocTableEntry | name=isEmpty}}
 
{{DocTableEntry | name=isEmpty}}
 
{{DocTableEntry | name=isLive}}
 
{{DocTableEntry | name=isLive}}
{{DocTableEntry | name=keytip}}
 
{{DocTableEntry | name=label}}
 
 
{{DocTableEntry | name=parent}}
 
{{DocTableEntry | name=parent}}
{{DocTableEntry | name=screentip}}
 
{{DocTableEntry | name=sizeString}}
 
{{DocTableEntry | name=supertip}}
 
{{DocTableEntry | name=tag}}
 
{{DocTableEntry | name=visible}}
 
 
{{DocTableEntry | name=xml}}
 
{{DocTableEntry | name=xml}}
 
{{DocTableEnd}}
 
{{DocTableEnd}}
Line 29: Line 17:
 
== {{Collections Section Title}} ==
 
== {{Collections Section Title}} ==
 
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
 
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
{{DocTableColEntry | controlName=rxPrimaryItem| propName=items}}
+
{{DocTableColEntry | controlName=rxPrimaryItem| propName=button}}
 +
{{DocTableColEntry | controlName=rxPrimaryItem| propName=menu}}
 
{{DocTableEntry | name=ribbonXControls}}
 
{{DocTableEntry | name=ribbonXControls}}
 
{{DocTableEnd}}
 
{{DocTableEnd}}
Line 42: Line 31:
 
== Delegates ==
 
== Delegates ==
 
{{DocTableBegin | Col1Name=Delegate Name | Col2Name=Description}}
 
{{DocTableBegin | Col1Name=Delegate Name | Col2Name=Description}}
{{DocTableEntry | name=getEnabled}}
 
{{DocTableEntry | name=getKeytip}}
 
{{DocTableEntry | name=getLabel}}
 
{{DocTableEntry | name=getScreentip}}
 
{{DocTableEntry | name=getSelectedItemIndex}}
 
{{DocTableEntry | name=getSupertip}}
 
{{DocTableEntry | name=getVisible}}
 
{{DocTableEntry | name=onAction_dropdown}}
 
 
{{DocTableEnd}}
 
{{DocTableEnd}}
  
 
== Events ==
 
== Events ==
{{DocTableBegin | Col1Name=Event Name | Col2Name=Description}}
 
{{DocTableEntry | name=OnActionEvent_dropdown}}
 
{{DocTableEntry | name=OnGetEnabled}}
 
{{DocTableEntry | name=OnGetKeytip}}
 
{{DocTableEntry | name=OnGetLabel}}
 
{{DocTableEntry | name=OnGetScreentip}}
 
{{DocTableEntry | name=OnGetSelectedItemIndex}}
 
{{DocTableEntry | name=OnGetSupertip}}
 
{{DocTableEntry | name=OnGetVisible}}
 
 
{{DocTableEnd}}
 
{{DocTableEnd}}
  

Latest revision as of 03:04, 13 March 2013

RxPrimaryItem.png

Description

rxPrimaryItem models element CT_PrimaryItem of the MS Custom UI XML specification which specifies a container for the primary UI of the containing Backstage group 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
parent The control's parent object
xml Returns the xml node that corresponds to the state of the control

Contained Controls

Property Name
Description
button The control's owned button
menu The control's owned menu
ribbonXControls The collection of all contained ribbonX controls

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

|}

Remarks

Examples

VBA

  1.  

C#

  1.  

VB.NET

  1.  

C++

  1.