Difference between revisions of "RxBackstageDropDown"

From Ribbon Commander Documentation
Jump to: navigation, search
Line 2: Line 2:
 
[[Category:Controls]]
 
[[Category:Controls]]
 
[[Category:2010 Controls]]
 
[[Category:2010 Controls]]
 +
 +
[[image: rxBackstageDropDown.png|right|link=]]
 +
== Description ==
 +
rxBackstageDropDown models element [http://msdn.microsoft.com/en-us/library/dd906729(v=office.12).aspx CT_BackstageDropDown] of the MS Custom UI XML specification which specifies a Backstage drop-down control.
 +
 +
== Properties ==
 +
{{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=isLive}}
 +
{{DocTableEntry | name=keytip}}
 +
{{DocTableEntry | name=label}}
 +
{{DocTableEntry | name=parent}}
 +
{{DocTableEntry | name=screentip}}
 +
{{DocTableEntry | name=sizeString}}
 +
{{DocTableEntry | name=supertip}}
 +
{{DocTableEntry | name=tag}}
 +
{{DocTableEntry | name=visible}}
 +
{{DocTableEntry | name=xml}}
 +
{{DocTableEnd}}
 +
 +
== {{Collections Section Title}} ==
 +
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
 +
{{DocTableColEntry | controlName=rxBackstageDropDown| propName=items}}
 +
{{DocTableEntry | name=ribbonXControls}}
 +
{{DocTableEnd}}
 +
 +
== Methods ==
 +
{{DocTableBegin | Col1Name=Method Name | Col2Name=Description}}
 +
{{DocTableEntry | name=clear}}
 +
{{DocTableEntry | name=clone}}
 +
{{DocTableEntry | name=readXml}}
 +
{{DocTableEnd}}
 +
 +
== Delegates ==
 +
{{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}}
 +
 +
== 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=OnGetSelectedIteIndex}}
 +
{{DocTableEntry | name=OnGetSupertip}}
 +
{{DocTableEntry | name=OnGetVisible}}
 +
{{DocTableEnd}}
 +
 +
 +
== Remarks ==
 +
 +
== Examples ==
 +
 +
=== VBA ===
 +
<syntaxhighlight lang="vb" line>
 +
</syntaxhighlight>
 +
 +
=== C# ===
 +
<syntaxhighlight lang="csharp" line>
 +
</syntaxhighlight>
 +
 +
=== VB.NET ===
 +
<syntaxhighlight lang="vb" line>
 +
</syntaxhighlight>
 +
 +
=== C++ ===
 +
<syntaxhighlight lang="cpp" line>
 +
</syntaxhighlight>

Revision as of 00:39, 13 March 2013

RxBackstageDropDown.png

Description

rxBackstageDropDown models element CT_BackstageDropDown of the MS Custom UI XML specification which specifies a Backstage drop-down control.

Properties

Property Name
Description
alignLabel Specifies the position where the control’s label is aligned
enabled Whether the controls is enabled
expand Specifies the directions in which the control expands to fill its parent container.
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
keytip Sets the control's keytip
label Sets the control's label
parent The control's parent object
screentip Sets the screentip, which appears on mouse hover
sizeString A representative string that sets the control's width
supertip Sets the control's supertip, a large screentip
tag Custom data
visible Whether the control is visible
xml Returns the xml node that corresponds to the state of the control

Contained Controls

Property Name
Description
items The collection of items in the drop-down
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
getEnabled Callback that sets the control's enabled state
getKeytip Callback that sets the keytip
getLabel Callback that sets the label
getScreentip Callback that sets the screentip
getSelectedItemIndex Callback that specifies the index of the selected item when the control is created/invalidated
getSupertip Callback that sets the supertip, a large screentip
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
OnGetEnabled Callback that sets the control's enabled state
OnGetKeytip Callback that sets the keytip
OnGetLabel Callback that sets the label
OnGetScreentip Callback that sets the screentip
Template:Name OnGetSelectedIteIndex Template:Desc OnGetSelectedIteIndex
OnGetSupertip Callback that sets the supertip, a large screentip
OnGetVisible Callback that sets the control's visible state


Remarks

Examples

VBA

  1.  

C#

  1.  

VB.NET

  1.  

C++

  1.  
Retrieved from ‘https://documentation.ribboncommander.com/index.php?title=RxBackstageDropDown&oldid=1276’