Difference between revisions of "RxGroup"

From Ribbon Commander Documentation
Jump to: navigation, search
Line 2: Line 2:
 
[[Category:Controls]]
 
[[Category:Controls]]
 
[[Category:2007 Controls]]
 
[[Category:2007 Controls]]
 +
 +
[[image: rxGroup.png|right|link=]]
 +
== Description ==
 +
rxGroup models element [http://msdn.microsoft.com/en-us/library/dd909839(v=office.12).aspx CT_Group] of the MS Custom UI XML specification which specifies a grouping of controls within a ribbon tab.
 +
 +
== Properties ==
 +
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
 +
{{DocTableEntry | name=autoScale}}
 +
{{DocTableEntry | name=centerVertically}}
 +
{{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=isLive}}
 +
{{DocTableEntry | name=keytip}}
 +
{{DocTableEntry | name=label}}
 +
{{DocTableEntry | name=parent}}
 +
{{DocTableEntry | name=screentip}}
 +
{{DocTableEntry | name=supertip}}
 +
{{DocTableEntry | name=tag}}
 +
{{DocTableEntry | name=visible}}
 +
{{DocTableEntry | name=xml}}
 +
{{DocTableEnd}}
 +
 +
== {{Collections Section Title}} ==
 +
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
 +
{{DocTableColEntry | controlName=rxGroup| propName=boxes}}
 +
{{DocTableColEntry | controlName=rxGroup| propName=buttonGroups}}
 +
{{DocTableColEntry | controlName=rxGroup| propName=buttons}}
 +
{{DocTableColEntry | controlName=rxGroup| propName=checkBoxes}}
 +
{{DocTableColEntry | controlName=rxGroup| propName=comboBoxes}}
 +
{{DocTableColEntry | controlName=rxGroup| propName=controls}}
 +
{{DocTableColEntry | controlName=rxGroup| propName=dialogLauncher}}
 +
{{DocTableColEntry | controlName=rxGroup| propName=dropDowns}}
 +
{{DocTableColEntry | controlName=rxGroup| propName=dynamicMenus}}
 +
{{DocTableColEntry | controlName=rxGroup| propName=editBoxes}}
 +
{{DocTableColEntry | controlName=rxGroup| propName=galleries}}
 +
{{DocTableColEntry | controlName=rxGroup| propName=labelControls}}
 +
{{DocTableColEntry | controlName=rxGroup| propName=menus}}
 +
{{DocTableEntry | name=ribbonXControls}}
 +
{{DocTableColEntry | controlName=rxGroup| propName=separators}}
 +
{{DocTableColEntry | controlName=rxGroup| propName=splitButtons}}
 +
{{DocTableColEntry | controlName=rxGroup| propName=toggleButtons}}
 +
{{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=getImage}}
 +
{{DocTableEntry | name=getKeytip}}
 +
{{DocTableEntry | name=getLabel}}
 +
{{DocTableEntry | name=getScreentip}}
 +
{{DocTableEntry | name=getSupertip}}
 +
{{DocTableEntry | name=getVisible}}
 +
{{DocTableEnd}}
 +
 +
== Events ==
 +
{{DocTableBegin | Col1Name=Event Name | Col2Name=Description}}
 +
{{DocTableEntry | name=OnGetImage}}
 +
{{DocTableEntry | name=OnGetKeytip}}
 +
{{DocTableEntry | name=OnGetLabel}}
 +
{{DocTableEntry | name=OnGetScreentip}}
 +
{{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 18:44, 12 March 2013

RxGroup.png

Description

rxGroup models element CT_Group of the MS Custom UI XML specification which specifies a grouping of controls within a ribbon tab.

Properties

Property Name
Description
autoScale Whether the control's contents automatically resize as the size of the containing window changes
centerVertically Whether the control's contents are centered vertically within the container
id The ID of a custom UI element. IDs must be unique
idMso The ID of a built-in control
idQ A qualified control ID. Qualified IDs allow different add-ins to modify the same custom group, tab, or menu
image A custom image or icon
imageMso The image of a built-in control
insertAfterMso The ID of a built-in control to be inserted after
insertAfterQ The ID of a control to be inserted after
insertBeforeMso The ID of a built-in control to be inserted before
insertBeforeQ The ID of control to be inserted before
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
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
boxes A collection of boxes
buttonGroups A collection of button groups
buttons A collection of buttons
checkBoxes A collection of check boxes
comboBoxes A collection of combo boxes
controls A collection of controls that can enable, disable or clone built-in controls
dialogLauncher A dialog-launching control
dropDowns A collection of drop-downs
dynamicMenus A collection of dynamic menus
editBoxes A collection of edit boxes
galleries A collection of galleries
labelControls A collection of label controls
menus A collection of menus
ribbonXControls The collection of all contained ribbonX controls
separators A collection of separators
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
getImage Callback for a custom image
getKeytip Callback that sets the keytip
getLabel Callback that sets the label
getScreentip Callback that sets the screentip
getSupertip Callback that sets the supertip, a large screentip
getVisible Callback that sets the control's visible state

Events

Event Name
Description
OnGetImage Callback for a custom image
OnGetKeytip Callback that sets the keytip
OnGetLabel Callback that sets the label
OnGetScreentip Callback that sets the screentip
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=RxGroup&oldid=1117’