CompatibilitySetting class

Office 2013 and later

Defines the CompatibilitySetting Class. When the object is serialized out as xml, its qualified name is w:compatSetting.

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.CompatibilitySetting

Namespace:  DocumentFormat.OpenXml.Wordprocessing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

public class CompatibilitySetting : OpenXmlLeafElement

[ISO/IEC 29500-1 1st Edition]

compatSetting (Custom Compatibility Setting)

This element specifies a custom compatibility setting. The semantics for this element are implementation-defined. [Note: This element can be used to store the transitional compatibility settings specified in Part 4 of /IEC 29500. end note]

[Example: Consider the following markup:

<w:compatSetting w:name="cooper" w:uri="http://www.example.com/exampleSetting" w:val="1"/>

This custom compatibility setting specifies that:

  • It is defined under the http://www.example.com/exampleSetting namespace.

  • Its name is cooper.

  • Its value is 1.

Beyond this, the properties of this setting are implementation-defined by the creator of the http://www.example.com/exampleSetting namespace. end example]

Parent Elements

compat (§17.15.1.21)

Attributes

Description

name (Name of Setting)

Specifies the name of a custom compatibility setting.

[Example: Consider the following markup:

<w:compatSetting w:name="cooper" w:uri="http://www.example.com/exampleSetting" w:val="1"/>

The name of this custom compatibility setting is cooper. end example]

The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13).

uri (Namespace of Setting)

Specifies the namespace under which the compatibility setting is defined.

[Example: Consider the following markup:

<w:compatSetting w:name="cooper" w:uri="http://www.example.com/exampleSetting" w:val="1"/>

The namespace of this custom compatibility setting is http://www.example.com/exampleSetting. end example]

The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13).

val (Value of Setting)

Specifies the value of a custom compatibility setting.

[Example: Consider the following markup:

<w:compatSetting w:name="cooper" w:uri="http://www.example.com/exampleSetting" w:val="1"/>

The value of this custom compatibility setting is 1. This value is interpreted using the implementation-defined behavior published by the creator of this property. end example]

The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13).

[Note: The W3C XML Schema definition of this element’s content model (CT_CompatSetting) is located in §A.1. end note]

© ISO/IEC29500: 2008.

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: