Difference between revisions of "RxBackstageLabelControl"

From Ribbon Commander Documentation
Jump to: navigation, search
 
Line 2: Line 2:
 
[[Category:Controls]]
 
[[Category:Controls]]
 
[[Category:2010 Controls]]
 
[[Category:2010 Controls]]
 +
 +
 +
[[image: rxBackstageLabelControl.png|310px|right|link=]]
 +
== Description ==
 +
rxBackstageLabelControl models element [http://msdn.microsoft.com/en-us/library/dd926967(v=office.12).aspx CT_BackstageLabelControl] of the MS Custom UI XML specification which specifies a Backstage control that displays a simple string of text.
 +
 +
== 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=label}}
 +
{{DocTableEntry | name=noWrap}}
 +
{{DocTableEntry | name=parent}}
 +
{{DocTableEntry | name=tag}}
 +
{{DocTableEntry | name=visible}}
 +
{{DocTableEntry | name=xml}}
 +
{{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=getLabel}}
 +
{{DocTableEntry | name=getVisible}}
 +
{{DocTableEnd}}
 +
 +
== Events ==
 +
{{DocTableBegin | Col1Name=Event Name | Col2Name=Description}}
 +
{{DocTableEntry | name=OnGetEnabled}}
 +
{{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>

Latest revision as of 20:20, 11 March 2013

RxBackstageLabelControl.png

Description

rxBackstageLabelControl models element CT_BackstageLabelControl of the MS Custom UI XML specification which specifies a Backstage control that displays a simple string of text.

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
label Sets the control's label
noWrap If true, text isn't automatically wrapped to appear in several lines if its length exceeds the control's visible client area
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

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
getLabel Callback that sets the label
getVisible Callback that sets the control's visible state

Events

Event Name
Description
OnGetEnabled Callback that sets the control's enabled state
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.