Difference between revisions of "RxTabSet"

From Ribbon Commander Documentation
Jump to: navigation, search
Line 2: Line 2:
 
[[Category:Controls]]
 
[[Category:Controls]]
 
[[Category:2007 Controls]]
 
[[Category:2007 Controls]]
 +
 +
[[image: rxTabSet.png|right|link=]]
 +
== Description ==
 +
rxTabSet models element [http://msdn.microsoft.com/en-us/library/dd953293(v=office.12).aspx CT_TabSet] of the MS Custom UI XML specification which specifies a list of contextual tab controls.
 +
 +
== Properties ==
 +
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
 +
{{DocTableEntry | name=id}}
 +
{{DocTableEntry | name=idMso}}
 +
{{DocTableEntry | name=idQ}}
 +
{{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=tag}}
 +
{{DocTableEntry | name=visible}}
 +
{{DocTableEntry | name=xml}}
 +
{{DocTableEnd}}
 +
 +
== {{Collections Section Title}} ==
 +
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
 +
{{DocTableColEntry | controlName=rxTab| propName=groups}}
 +
{{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=getKeytip}}
 +
{{DocTableEntry | name=getLabel}}
 +
{{DocTableEntry | name=getVisible}}
 +
{{DocTableEnd}}
 +
 +
== Events ==
 +
{{DocTableBegin | Col1Name=Event Name | Col2Name=Description}}
 +
{{DocTableEntry | name=OnGetKeytip}}
 +
{{DocTableEntry | name=OnGetLabel}}
 +
{{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 20:58, 12 March 2013

RxTabSet.png

Description

rxTabSet models element CT_TabSet of the MS Custom UI XML specification which specifies a list of contextual tab controls.

Properties

Property Name
Description
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
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
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
groups A collection of groups
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
getKeytip Callback that sets the keytip
getLabel Callback that sets the label
getVisible Callback that sets the control's visible state

Events

Event Name
Description
OnGetKeytip Callback that sets the keytip
OnGetLabel Callback that sets the label
OnGetVisible Callback that sets the control's visible state


Remarks

Examples

VBA

  1.  

C#

  1.  

VB.NET

  1.  

C++

  1.