Difference between revisions of "RxCustomUI"

From Ribbon Commander Documentation
Jump to: navigation, search
(→‎Static Methods)
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
[[Category:Controls]]
 
[[Category:Controls]]
 
[[Category:2007 Controls]]
 
[[Category:2007 Controls]]
 +
 +
 +
[[image: rxCustomUI.png|right|link=]]
 +
== Description ==
 +
rxCustomUI models element [http://msdn.microsoft.com/en-us/library/dd772864(v=office.12).aspx CT_CustomUI] of the MS Custom UI XML specification which specifies the root control in the Custom UI hierarchy.
 +
 +
== Properties ==
 +
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
 +
{{DocTableEntry | name=addinDescription}}
 +
{{DocTableEntry | name=application}}
 +
{{DocTableEntry | name=contextID}}
 +
{{DocTableEntry | name=customUIMode}}
 +
{{DocTableEntry | name=dispatchObject}}
 +
{{DocTableEntry | name=dispatchObject_weakRef}}
 +
{{DocTableEntry | name=isEmpty}}
 +
{{DocTableEntry | name=isLive}}
 +
{{DocTableEntry | name=isReloadPending}}
 +
{{DocTableEntry | name=maxTargetOfficeVersion}}
 +
{{DocTableEntry | name=officeRibbonUI}}
 +
{{DocTableEntry | name=parent}}
 +
{{DocTableEntry | name=targetOfficeVersion}}
 +
{{DocTableEnd}}
 +
 +
== {{Collections Section Title}} ==
 +
{{DocTableBegin | Col1Name=Property Name | Col2Name=Description}}
 +
{{DocTableColEntry | controlName=rxCustomUI| propName=backstage}}
 +
{{DocTableColEntry | controlName=rxCustomUI| propName=commands}}
 +
{{DocTableColEntry | controlName=rxCustomUI| propName=contextMenus}}
 +
{{DocTableColEntry | controlName=rxCustomUI| propName=namespaces}}
 +
{{DocTableColEntry | controlName=rxCustomUI| propName=ribbon}}
 +
{{DocTableEntry | name=ribbonXControls_rxCustomUI}}
 +
{{DocTableEnd}}
 +
 +
== Methods ==
 +
{{DocTableBegin | Col1Name=Method Name | Col2Name=Description}}
 +
{{DocTableEntry | name=activateTab}}
 +
{{DocTableEntry | name=activateTabMso}}
 +
{{DocTableEntry | name=activateTabQ}}
 +
{{DocTableEntry | name=clear}}
 +
{{DocTableEntry | name=invalidate}}
 +
{{DocTableEntry | name=invalidateControl}}
 +
{{DocTableEntry | name=invalidateControlMso}}
 +
{{DocTableEntry | name=make_delegate}}
 +
{{DocTableEntry | name=populateFromXml}}
 +
{{DocTableEntry | name=refresh}}
 +
{{DocTableEntry | name=rxCustomUI}}
 +
{{DocTableEntry | name=serializeToXml}}
 +
{{DocTableEnd}}
 +
 +
== Static Methods ==
 +
{{DocTableBegin | Col1Name=Method Name | Col2Name=Description}}
 +
{{DocTableEntry | name=create}}
 +
{{DocTableEntry | name=defaultInstance}}
 +
{{DocTableEntry | name=globalCustomUIs}}
 +
{{DocTableEnd}}
 +
 +
== Delegates ==
 +
{{DocTableBegin | Col1Name=Delegate Name | Col2Name=Description}}
 +
{{DocTableEntry | name=onCallbackError}}
 +
{{DocTableEntry | name=onLoad}}
 +
{{DocTableEntry | name=loadImage}}
 +
{{DocTableEnd}}
 +
 +
== Events ==
 +
{{DocTableBegin | Col1Name=Event Name | Col2Name=Description}}
 +
{{DocTableEntry | name=OnCallbackErrorEvent}}
 +
{{DocTableEntry | name=OnLoadEvent}}
 +
{{DocTableEntry | name=OnLoadImageEvent}}
 +
{{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 21:06, 14 March 2013

RxCustomUI.png

Description

rxCustomUI models element CT_CustomUI of the MS Custom UI XML specification which specifies the root control in the Custom UI hierarchy.

Properties

Property Name
Description
addinDescription (read-only) Returns the add-in description of an rxCustomUI object's context
application (read-only) Returns a weakly-typed reference to the target application object
contextId (read-only) Returns the unique string identifier of an rxCustomUI object's context
customUIMode The rxCustomUI object's mode
dispatchObject A client-supplied dispatch object for delegate callbacks
dispatchObject_weakRef A client-supplied dispatch object for delegate callbacks held by weak reference
isEmpty Read-only property; returns true if the control is empty
isLive Read-only property; returns true if the control is live
isReloadPending (read-only) Whether a reload is required in order to display all changed state in this context
maxTargetOfficeVersion The maximum office version override for this context
officeRibbonUI (read-only) Returns a weakly-typed reference to this context's Office RibbonUI object
parent The control's parent object
targetOfficeVersion (read-only) Returns the major version of the hosting Office application

Contained Controls

Property Name
Description
backstage A reference to the backstage of this context
commands A collection of commands
contextMenus A collection of context menus
namespaces The collection of XML namespaces used in the control's context
ribbon A reference to the ribbon of this context
ribbonXControls The collection of all Dynamic RibbonX controls in this context

Methods

Method Name
Description
activateTab Activates a custom tab
activateTabMso Activates a built-in tab
activateTabQ Activates a custom shared tab
clear Clears the control's state
invalidate Invalidates all controls in this context
invalidateControl Invalidates a single control in this context
invalidateControlMso Invalidates a single built-in control in this context
make_delegate Creates a new rxDelegate object that is associated with this context
populateFromXml Reads this context's state from xml
refresh Renders this context's UI
rxCustomUI(string, string, rxCustomUIMode) (.NET-specific) Constructor
serializeToXml Serializes this context's state to xml

Static Methods

Method Name
Description
create Creates a new rxCustomUI context
defaultInstance Returns the rxCustomUI of the default context
globalCustomUIs (VBA-specific) Returns the collection of rxCustomUI objects with global dispatch in the current session

Delegates

Delegate Name
Description
onCallbackError Callback used to report errors that occur during other callbacks
onLoad Callback invoked when custom UI is loaded
loadImage Callback used to load all images

Events

Event Name
Description
OnCallbackErrorEvent Callback used to report errors that occur during other callbacks
OnLoadEvent Callback invoked when custom UI is loaded
OnLoadImageEvent Callback used to load all images

Remarks

Examples

VBA

  1.  

C#

  1.  

VB.NET

  1.  

C++

  1.  
Retrieved from ‘https://documentation.ribboncommander.com/index.php?title=RxCustomUI&oldid=1970’