MS Oextxml
MS Oextxml
MS Oextxml
Tools. The Open Specifications documentation does not require the use of Microsoft programming
tools or programming environments in order for you to develop an implementation. If you have access
to Microsoft programming tools and environments, you are free to take advantage of them. Certain
Open Specifications documents are intended for use in conjunction with publicly available standards
specifications and network programming art and, as such, assume that the reader either is familiar
with the aforementioned material or has immediate access to it.
1 / 14
[MS-OEXTXML] - v20210817
Office Shared Extensibility in Office Open XML
Copyright © 2021 Microsoft Corporation
Release: August 17, 2021
Revision Summary
2 / 14
[MS-OEXTXML] - v20210817
Office Shared Extensibility in Office Open XML
Copyright © 2021 Microsoft Corporation
Release: August 17, 2021
Table of Contents
1 Introduction ............................................................................................................ 4
1.1 Glossary ........................................................................................................... 4
1.2 References ........................................................................................................ 4
1.2.1 Normative References ................................................................................... 4
1.2.2 Informative References ................................................................................. 4
1.3 Overview .......................................................................................................... 5
1.4 Relationship to Protocols and Other Structures ...................................................... 5
1.5 Applicability Statement ....................................................................................... 5
1.6 Versioning and Localization ................................................................................. 5
1.7 Vendor-Extensible Fields ..................................................................................... 5
2 Structures ............................................................................................................... 6
2.1 http://schemas.microsoft.com/office/2019/extlst ................................................... 6
2.1.1 Elements ..................................................................................................... 6
2.1.2 Attributes .................................................................................................... 6
2.1.3 Complex Types ............................................................................................. 6
2.1.3.1 CT_Extension ......................................................................................... 6
2.1.3.2 CT_ExtensionList .................................................................................... 6
2.1.4 Simple Types ............................................................................................... 7
3 Structure Examples ................................................................................................. 8
3.1 Using Extension List Types in a Markup Specification .............................................. 8
3.2 Using a New Part and Extension List Types to Extend a Previously Defined Markup
Specification ...................................................................................................... 8
4 Security ................................................................................................................. 10
4.1 Security Considerations for Implementers ........................................................... 10
4.2 Index of Security Fields .................................................................................... 10
5 Appendix A: Full XML Schemas .............................................................................. 11
5.1 http://schemas.microsoft.com/office/2019/extlst Schema ..................................... 11
6 Appendix B: Product Behavior ............................................................................... 12
7 Change Tracking .................................................................................................... 13
8 Index ..................................................................................................................... 14
3 / 14
[MS-OEXTXML] - v20210817
Office Shared Extensibility in Office Open XML
Copyright © 2021 Microsoft Corporation
Release: August 17, 2021
1 Introduction
This document specifies complex types for representing extension lists in the context of Open XML file
formats described in [ISO/IEC29500-1:2016]. The new types are presented using the extensibility
mechanisms described in [ISO/IEC29500-3:2015].
Sections 1.7 and 2 of this specification are normative. All other sections and examples in this
specification are informative.
1.1 Glossary
MAY, SHOULD, MUST, SHOULD NOT, MUST NOT: These terms (in all caps) are used as defined
in [RFC2119]. All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT.
1.2 References
Links to a document in the Microsoft Open Specifications library point to the correct section in the
most recently published version of the referenced document. However, because individual documents
in the library are not updated at the same time, the section numbers in the documents may not
match. You can confirm the correct section numbering by checking the Errata.
We conduct frequent surveys of the normative references to assure their continued availability. If you
have any issue with finding a normative reference, please contact [email protected]. We will
assist you in finding the relevant information.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC
2119, March 1997, https://www.rfc-editor.org/rfc/rfc2119.html
[XMLSCHEMA1/2] Thompson, H., Beech, D., Maloney, M., and Mendelsohn, N., Eds., "XML Schema
Part 1: Structures Second Edition", W3C Recommendation, October 2004,
https://www.w3.org/TR/2004/REC-xmlschema-1-20041028/
[XMLSCHEMA2] Biron, P.V., Ed. and Malhotra, A., Ed., "XML Schema Part 2: Datatypes", W3C
Recommendation, May 2001, https://www.w3.org/TR/2001/REC-xmlschema-2-20010502/
None.
4 / 14
[MS-OEXTXML] - v20210817
Office Shared Extensibility in Office Open XML
Copyright © 2021 Microsoft Corporation
Release: August 17, 2021
1.3 Overview
The complex types specified in this document represent extension lists. Extension lists provide a
convention for extending a file format at wherever an extension list has been predefined.
The types can be used to extend the Office Open XML file formats as described in [ISO/IEC29500-
1:2016] and this document. See section 3 for examples of using these types in markup specifications.
This specification is dependent on the structures and concepts defined in the following references:
This document specifies complex types for representing extension lists. These types can be used by
extensions to the Office Open XML file formats ([ISO/IEC29500-1:2016]). The types specified in this
document are not applicable as a stand-alone file format.
None.
None.
5 / 14
[MS-OEXTXML] - v20210817
Office Shared Extensibility in Office Open XML
Copyright © 2021 Microsoft Corporation
Release: August 17, 2021
2 Structures
2.1 http://schemas.microsoft.com/office/2019/extlst
2.1.1 Elements
None.
2.1.2 Attributes
None.
2.1.3.1 CT_Extension
Attributes:
uri: A xsd:token ([XMLSCHEMA2] section 3.3.2) attribute that specifies a unique identifier for the
extension.
The following W3C XML Schema ([XMLSCHEMA1/2] section 2.1) fragment specifies the contents of this
complex type.
<xsd:complexType name="CT_Extension">
<xsd:sequence>
<xsd:any processContents="lax"/>
</xsd:sequence>
<xsd:attribute name="uri" type="xsd:token"/>
</xsd:complexType>
See section 5.1 for the full W3C XML Schema ([XMLSCHEMA1/2] section 2.1).
2.1.3.2 CT_ExtensionList
An extension list denotes a predefined place in a markup specification that allows for future
extensibility. Future extensibility is possible because the extensions within an extension list can
reference future markup specifications.
Any number of extensions are allowed within an extension list and the extensions are allowed to
appear in any order.
When an extension list is processed, a consumer might not understand all of the extensions. A
consumer determines whether it can understand an extension based on the uri of the extension
6 / 14
[MS-OEXTXML] - v20210817
Office Shared Extensibility in Office Open XML
Copyright © 2021 Microsoft Corporation
Release: August 17, 2021
(CT_Extension). If a consumer does not understand an extension, it MUST NOT attempt to interpret
the contents. Instead, it MUST preserve the extension unless some ancestor of the extension list has
been discarded. The extension is preserved as-is, excepting any namespace mapping that is necessary
to remain compliant with the XML standard.
Markup namespaces within extensions are not required to be listed in the Ignorable Compatibility-
Rule attribute ([ISO/IEC29500-3:2015] section 7.2).
Child Elements:
The following W3C XML Schema ([XMLSCHEMA1/2] section 2.1) fragment specifies the contents of this
complex type.
<xsd:complexType name="CT_ExtensionList">
<xsd:sequence>
<xsd:element name="ext" type="CT_Extension" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
See section 5.1 for the full W3C XML Schema ([XMLSCHEMA1/2] section 2.1).
None.
7 / 14
[MS-OEXTXML] - v20210817
Office Shared Extensibility in Office Open XML
Copyright © 2021 Microsoft Corporation
Release: August 17, 2021
3 Structure Examples
This example shows how to use the extension list types of this document in a markup specification.
ContosoWidgets is a hypothetical markup specification that extends the Office Open XML file formats
([ISO/IEC29500-1:2016]) by allowing the definition of widgets within a document.
When ContosoWidgets was originally defined, it was known that each widget had a name and id. Thus,
the CT_ContosoWidget type has attributes for both.
Additionally, it was known that there was a possibility that a widget might have more than just a
name and id in the future. To account for this, CT_ContosoWidget is extensible via an extension list
child element.
For that extension list element, CT_ContosoWidgets uses the CT_ExtensionList type defined in this
document. The element conforms to the extension list behavior detailed in this document.
<xsd:schema xmlns="http://www.example.com/ContosoWidgets"
targetNamespace="http://www.example.com/ContosoWidgets" elementFormDefault="qualified"
attributeFormDefault="unqualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:oel="http://schemas.microsoft.com/office/2019/extlst">
<xsd:import id="oel" namespace="http://schemas.microsoft.com/office/2019/extlst"
schemaLocation="officeextlst.xsd"/>
<xsd:element name="Widgets" type="CT_ContosoWidgets"/>
<xsd:complexType name="CT_ContosoWidgets">
<xsd:sequence>
<xsd:element name="Widget" type="CT_ContosoWidget" minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="CT_ContosoWidget">
<xsd:sequence>
<xsd:element name="extLst" minOccurs="0" maxOccurs="1" type="oel:CT_ExtensionList"/>
</xsd:sequence>
<xsd:attribute name="name" type="xsd:string" use="required"/>
<xsd:attribute name="id" type="xsd:int" use="required"/>
</xsd:complexType>
</xsd:schema>
3.2 Using a New Part and Extension List Types to Extend a Previously Defined
Markup Specification
This example shows how to extend a previously defined markup specification by using a new part and
make the new part extensible with the extension list types of this document.
ContosoGizmos is a hypothetical markup specification that extends the Office Open XML file formats
([ISO/IEC29500-1:2016]) by allowing the definition of gizmos within a document.
Below is the initial version of ContosoGizmos. Each gizmo has a name and a unique id.
<xsd:schema xmlns="http://www.example.com/ContosoGizmos"
targetNamespace="http://www.example.com/ContosoGizmos" elementFormDefault="qualified"
attributeFormDefault="unqualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="Gizmos" type="CT_ContosoGizmos"/>
<xsd:complexType name="CT_ContosoGizmos">
<xsd:sequence>
<xsd:element name="Gizmo" type="CT_ContosoGizmo" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
8 / 14
[MS-OEXTXML] - v20210817
Office Shared Extensibility in Office Open XML
Copyright © 2021 Microsoft Corporation
Release: August 17, 2021
</xsd:complexType>
<xsd:complexType name="CT_ContosoGizmo">
<xsd:attribute name="name" type="xsd:string" use="required"/>
<xsd:attribute name="id" type="xsd:int" use="required"/>
</xsd:complexType>
</xsd:schema>
One option for addressing this need is to update Gizmos. However, existing readers would be unable
to fully understand the new version since the elements did not exist at the time of their
implementation. Depending on how exactly Gizmos was updated, those readers would either err while
processing the new version or fail to preserve the new content.
An option that avoids those issues is to create a new XML part with the size data, mapping it to a
gizmo by id. Many existing readers, such as Microsoft Office, preserve unknown parts that are related
to known parts (see [ISO/IEC29500-1:2016] section 9.1). Thus, these existing readers will preserve
an added part that is unknown to them but related to a known part.
In this example scenario, there has already been a need to specify more data for gizmos. To handle
the possibility of specifying even more data in the future, one option is to make the new part
extensible with extension lists. Any future new data can be specified in an extension.
Below is an example schema for the new part ContosoGizmosExtended. It is a list of the additional
data for each gizmo, mapped by id. The additional data includes the size and extension list.
<xsd:schema xmlns="http://www.example.com/ContosoGizmosExtended"
targetNamespace="http://www.example.com/ContosoGizmosExtended" elementFormDefault="qualified"
attributeFormDefault="unqualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:oel="http://schemas.microsoft.com/office/2019/extlst">
<xsd:import id="oel" namespace="http://schemas.microsoft.com/office/2019/extlst"
schemaLocation="officeextlst.xsd"/>
<xsd:element name="GizmosExtended" type="CT_ContosoGizmosExtended"/>
<xsd:complexType name="CT_ContosoGizmosExtended">
<xsd:sequence>
<xsd:element name="GizmoExtended" type="CT_ContosoGizmoExtended" minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="CT_ContosoGizmoExtended">
<xsd:sequence>
<xsd:element name="Size" type="CT_ContosoSize" minOccurs="0" maxOccurs="1"/>
<xsd:element name="extLst" type="oel:CT_ExtensionList" minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="id" type="xsd:int" use="required"/>
</xsd:complexType>
<xsd:complexType name="CT_ContosoSize">
<xsd:attribute name="width" type="xsd:int" use="required"/>
<xsd:attribute name="height" type="xsd:int" use="required"/>
</xsd:complexType>
</xsd:schema>
9 / 14
[MS-OEXTXML] - v20210817
Office Shared Extensibility in Office Open XML
Copyright © 2021 Microsoft Corporation
Release: August 17, 2021
4 Security
None.
None.
10 / 14
[MS-OEXTXML] - v20210817
Office Shared Extensibility in Office Open XML
Copyright © 2021 Microsoft Corporation
Release: August 17, 2021
5 Appendix A: Full XML Schemas
Schema name Prefix Section
11 / 14
[MS-OEXTXML] - v20210817
Office Shared Extensibility in Office Open XML
Copyright © 2021 Microsoft Corporation
Release: August 17, 2021
6 Appendix B: Product Behavior
The information in this specification is applicable to the following Microsoft products or supplemental
software. References to product versions include updates to those products.
Exceptions, if any, are noted in this section. If an update version, service pack or Knowledge Base
(KB) number appears with a product name, the behavior changed in that update. The new behavior
also applies to subsequent updates unless otherwise specified. If a product edition appears with the
product version, behavior is different in that product edition.
Unless otherwise specified, any statement of optional behavior in this specification that is prescribed
using the terms "SHOULD" or "SHOULD NOT" implies product behavior in accordance with the
SHOULD or SHOULD NOT prescription. Unless otherwise specified, the term "MAY" implies that the
product does not follow the prescription.
12 / 14
[MS-OEXTXML] - v20210817
Office Shared Extensibility in Office Open XML
Copyright © 2021 Microsoft Corporation
Release: August 17, 2021
7 Change Tracking
This section identifies changes that were made to this document since the last release. Changes are
classified as Major, Minor, or None.
The revision class Major means that the technical content in the document was significantly revised.
Major changes affect protocol interoperability or implementation. Examples of major changes are:
The revision class Minor means that the meaning of the technical content was clarified. Minor changes
do not affect protocol interoperability or implementation. Examples of minor changes are updates to
clarify ambiguity at the sentence, paragraph, or table level.
The revision class None means that no new technical changes were introduced. Minor editorial and
formatting changes may have been made, but the relevant technical content is identical to the last
released version.
The changes made to this document are listed in the following table. For more information, please
contact [email protected].
Revision
Section Description
class
3.2 Using a New Part and Extension List Types to Extend a Updated the property name in
Minor
Previously Defined Markup Specification the specification.
13 / 14
[MS-OEXTXML] - v20210817
Office Shared Extensibility in Office Open XML
Copyright © 2021 Microsoft Corporation
Release: August 17, 2021
8 Index
A field index 10
implementer considerations 10
Applicability 5
T
C
Tracking changes 13
Change tracking 13
U
E
Using a New Part and Extension List Types to Extend
Examples a Previously Defined Markup Specification
Using a New Part and Extension List Types to example 8
Extend a Previously Defined Markup Using Extension List Types in a Markup Specification
Specification 8 example 8
Using Extension List Types in a Markup
Specification 8 V
F Vendor-extensible fields 5
Versioning 5
Fields - security index 10
Fields - vendor-extensible 5 X
Full XML schema 11
XML schema 11
G
Glossary 4
Localization 5
Normative references 4
Overview (synopsis) 5
Product behavior 12
References 4
informative 4
normative 4
Relationship to protocols and other structures 5
Security
14 / 14
[MS-OEXTXML] - v20210817
Office Shared Extensibility in Office Open XML
Copyright © 2021 Microsoft Corporation
Release: August 17, 2021