Difference between revisions of "RxLayoutContainer"

From Ribbon Commander Documentation
Jump to: navigation, search
Line 2: Line 2:
 
[[Category:Controls]]
 
[[Category:Controls]]
 
[[Category:2010 Controls]]
 
[[Category:2010 Controls]]
 +
 +
[[image: rxLayoutContainer.png|right|link=]]
 +
== Description ==
 +
rxLayoutContainer models element [http://msdn.microsoft.com/en-us/library/dd951604(v=office.12).aspx CT_LayoutContainer] of the MS Custom UI XML specification which specifies a grouping container control that aligns child controls horizontally or vertically.
 +
 +
== Properties ==
 +
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
 +
{{DocTableEntry | name=align}}
 +
{{DocTableEntry | name=expand}}
 +
{{DocTableEntry | name=id}}
 +
{{DocTableEntry | name=idQ}}
 +
{{DocTableEntry | name=isEmpty}}
 +
{{DocTableEntry | name=isLive}}
 +
{{DocTableEntry | name=parent}}
 +
{{DocTableEntry | name=tag}}
 +
{{DocTableEntry | name=xml}}
 +
{{DocTableEnd}}
 +
 +
== {{Collections Section Title}} ==
 +
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
 +
{{DocTableColEntry | controlName=rxLayoutContainer| propName=buttons}}
 +
{{DocTableColEntry | controlName=rxLayoutContainer| propName=checkBoxes}}
 +
{{DocTableColEntry | controlName=rxLayoutContainer| propName=comboBoxes}}
 +
{{DocTableColEntry | controlName=rxLayoutContainer| propName=dropDowns}}
 +
{{DocTableColEntry | controlName=rxLayoutContainer| propName=editBoxes}}
 +
{{DocTableColEntry | controlName=rxLayoutContainer| propName=groupBoxes}}
 +
{{DocTableColEntry | controlName=rxLayoutContainer| propName=hyperlinks}}
 +
{{DocTableColEntry | controlName=rxLayoutContainer| propName=imageControls}}
 +
{{DocTableColEntry | controlName=rxLayoutContainer| propName=labelControls}}
 +
{{DocTableColEntry | controlName=rxLayoutContainer| propName=layoutChildren}}
 +
{{DocTableColEntry | controlName=rxLayoutContainer| propName=layoutContainers}}
 +
{{DocTableColEntry | controlName=rxLayoutContainer| propName=radioGroups}}
 +
{{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}}
 +
{{DocTableEnd}}
 +
 +
== Events ==
 +
{{DocTableBegin | Col1Name=Event Name | Col2Name=Description}}
 +
{{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 02:53, 13 March 2013

RxLayoutContainer.png

Description

rxLayoutContainer models element CT_LayoutContainer of the MS Custom UI XML specification which specifies a grouping container control that aligns child controls horizontally or vertically.

Properties

Property Name
Description
align Specifies where child controls are aligned within a container control
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
parent The control's parent object
tag Custom data
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
comboBoxes A collection of combo boxes
dropDowns A collection of drop-downs
editBoxes A collection of edit boxes
groupBoxes A collection of group boxes
hyperlinks A collection of hyperlinks
imageControls A collection of image controls
labelControls A collection of label controls
Template:Name layoutChildren rxLayoutContainer Specifies the direction that child controls are laid out within a container control
layoutContainers A collection of layout containers
radioGroups A collection of radio group controls
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

Event Name
Description

Remarks

Examples

VBA

  1.  

C#

  1.  

VB.NET

  1.  

C++

  1.