CustomUI Class

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

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.OpenXmlPartRootElement
        DocumentFormat.OpenXml.Office2010.CustomUI.CustomUI

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

Syntax

'Declaration
<OfficeAvailabilityAttribute(FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Backstage), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Ribbon), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(ContextMenus), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(Commands), FileFormatVersions.Office2010)> _
Public Class CustomUI _
    Inherits OpenXmlPartRootElement
'Usage
Dim instance As CustomUI
[OfficeAvailabilityAttribute(FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Backstage), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Ribbon), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(ContextMenus), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(Commands), FileFormatVersions.Office2010)]
public class CustomUI : OpenXmlPartRootElement

Remarks

The following table lists the possible child types:

  • Commands <mso14:commands>

  • Ribbon <mso14:ribbon>

  • Backstage <mso14:backstage>

  • ContextMenus <mso14:contextMenus>

2.2.1 customUI

Target namespace: https://schemas.microsoft.com/office/2007/10/customui

A CT_CustomUI element 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.85 CT_CustomUI

Target namespace: https://schemas.microsoft.com/office/2007/10/customui

Referenced by: customUI

Specifies the root tag in a Custom UI document.

Child Elements:

commands : A CT_Commands element.

ribbon : A CT_Ribbon element.

outSpace : A CT_OutSpace element.

contextMenus : A CT_ContextMenus element.

Attributes:

onLoad : An ST_Delegate attribute that specifies the name of a callback function which 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 which 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="outSpace" type="CT_OutSpace" 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).

Thread Safety

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

See Also

Reference

CustomUI Members

DocumentFormat.OpenXml.Office2010.CustomUI Namespace