CustomUI class

Office 2013 and later

Defines the CustomUI Class. The root element of RibbonAndBackstageCustomizationsPart. When the object is serialized out as xml, its qualified name is mso14:customUI.

Namespace:  DocumentFormat.OpenXml.Office2010.CustomUI
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.

2.2.1 customUI

Target namespace: http://schemas.microsoft.com/office/2009/07/customui

A CT_CustomUI element, as specified in section 2.3.39, that specifies the root tag in a Custom UI document.

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this element.

<xsd:element name="customUI" type="CT_CustomUI"/>

See section 5.1 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

2.3.39 CT_CustomUI

Target namespace: http://schemas.microsoft.com/office/2009/07/customui

Referenced by: customUI

Specifies the root tag in a Custom UI document.

Child Elements:

commands: A CT_Commands element, as specified in section 2.3.30.

ribbon: A CT_Ribbon element, as specified in section 2.3.64.

backstage: A CT_Backstage element, as specified in section 2.3.1.

contextMenus: A CT_ContextMenus element, as specified in section 2.3.32.

Attributes:

onLoad: An ST_Delegate attribute, as specified in section 2.4.7, that specifies the name of a callback function that is called when the custom UI in this document is loaded by the application.

loadImage: An ST_Delegate attribute that specifies the name of a callback function that is called when the application needs to load an icon image.

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.

<xsd:complexType name="CT_CustomUI">

<xsd:sequence>

<xsd:element name="commands" type="CT_Commands" minOccurs="0" maxOccurs="1"/>

<xsd:element name="ribbon" type="CT_Ribbon" minOccurs="0" maxOccurs="1"/>

<xsd:element name="backstage" type="CT_Backstage" minOccurs="0" maxOccurs="1"/>

<xsd:element name="contextMenus" type="CT_ContextMenus" minOccurs="0" maxOccurs="1"/>

</xsd:sequence>

<xsd:attribute name="onLoad" type="ST_Delegate" use="optional"/>

<xsd:attribute name="loadImage" type="ST_Delegate" use="optional"/>

</xsd:complexType>

See section 5.1 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: