Difference between revisions of "RxBackstageTab"

From Ribbon Commander Documentation
Jump to: navigation, search
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
 
[[Category:Controls]]
 
[[Category:Controls]]
 
[[Category:2010 Controls]]
 
[[Category:2010 Controls]]
 +
 +
[[image: rxBackstageTab.png|right|link=]]
 +
== Description ==
 +
rxBackstageTab models element [http://msdn.microsoft.com/en-us/library/dd947939(v=office.12).aspx CT_BackstageTab] of the MS Custom UI XML specification which specifies a Backstage tab control.
 +
 +
== Properties ==
 +
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
 +
{{DocTableEntry | name=columnWidthPercent}}
 +
{{DocTableEntry | name=enabled}}
 +
{{DocTableEntry | name=firstColumnMaxWidth}}
 +
{{DocTableEntry | name=firstColumnMinWidth}}
 +
{{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=secondColumnMaxWidth}}
 +
{{DocTableEntry | name=secondColumnMinWidth}}
 +
{{DocTableEntry | name=tag}}
 +
{{DocTableEntry | name=title}}
 +
{{DocTableEntry | name=visible}}
 +
{{DocTableEntry | name=xml}}
 +
{{DocTableEnd}}
 +
 +
== {{Collections Section Title}} ==
 +
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
 +
{{DocTableColEntry | controlName=rxBackstageTab| propName=firstColumn}}
 +
{{DocTableEntry | name=ribbonXControls}}
 +
{{DocTableColEntry | controlName=rxBackstageTab| propName=secondColumn}}
 +
{{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=getTitle}}
 +
{{DocTableEntry | name=getVisible}}
 +
{{DocTableEnd}}
 +
 +
== Events ==
 +
{{DocTableBegin | Col1Name=Event Name | Col2Name=Description}}
 +
{{DocTableEntry | name=OnGetEnabled}}
 +
{{DocTableEntry | name=OnGetKeytip}}
 +
{{DocTableEntry | name=OnGetLabel}}
 +
{{DocTableEntry | name=OnGetTitle}}
 +
{{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>

Latest revision as of 01:21, 13 March 2013

RxBackstageTab.png

Description

rxBackstageTab models element CT_BackstageTab of the MS Custom UI XML specification which specifies a Backstage tab control.

Properties

Property Name
Description
columnWidthPercent The percentage of the Backstage width occupied by a tab
enabled Whether the controls is enabled
firstColumnMaxWidth The maximum width of a backstage tab's first column
firstColumnMinWidth The minimum width of a backstage tab's first column
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
secondColumnMaxWidth The maximum width of a backstage tab's second column
secondColumnMinWidth The minimum width of a backstage tab's second column
tag Custom data
title The control's title
visible Whether the control is visible
xml Returns the xml node that corresponds to the state of the control

Contained Controls

Property Name
Description
firstColumn A collection of Backstage controls
ribbonXControls The collection of all contained ribbonX controls
secondColumn A collection of Backstage 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
getTitle Callback that sets the control's title
getVisible Callback that sets the control's visible state

Events

Event Name
Description
OnGetEnabled Callback that sets the control's enabled state
OnGetKeytip Callback that sets the keytip
OnGetLabel Callback that sets the label
OnGetTitle Callback that sets the control's title
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=RxBackstageTab&oldid=1315’