ColorSchemeMapping Class

Theme Color Mappings.When the object is serialized out as xml, its qualified name is w:clrSchemeMapping.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class ColorSchemeMapping _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As ColorSchemeMapping
public class ColorSchemeMapping : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

17.15.1.20 clrSchemeMapping (Theme Color Mappings)

This element specifies the theme color, stored in the document's Theme part to which the value of this theme color shall be mapped. This mapping enables multiple theme colors to be chained together.

[Example: Consider a WordprocessingML document that must have the theme color value background1 mapped to the theme color light1 as defined in the document's theme part. This requirement would be specified using the following WordprocessingML in the document settings:

<w:clrSchemeMapping w:bg1="light1" />

The clrSchemeMapping element's attribute background1 has a value of light1, specifying that theme color value background1 must be mapped to the theme color light1. end example]

Parent Elements

settings (§17.15.1.78)

Attributes

Description

accent1 (Accent 1 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the accent1 theme color shall be used.

[Example: Consider a WordprocessingML document that must have references to the theme color accent1 mapped to the theme color lt1 as defined in the document's theme part. This requirement would be specified using the following WordprocessingML in the document settings:

<w:clrSchemeMapping w:accent1="light1" />

The accent1 attribute has a value of light1, specifying that uses of the theme color value accent1 must be mapped to the theme color lt1. end example]

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

accent2 (Accent 2 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the accent2 theme color shall be used.

[Example: Consider a WordprocessingML document that must have the references to the theme color accent2 mapped to the theme color hlink as defined in the document's theme part. This requirement would be specified using the following WordprocessingML in the document settings:

<w:clrSchemeMapping w:accent2="hyperlink" />

The accent2 attribute has a value of hyperlink, specifying that uses of the theme color value accent2 must be mapped to the theme color hlink. end example]

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

accent3 (Accent3 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the accent3 theme color shall be used.

[Example: Consider a WordprocessingML document that must have references to the theme color accent3 mapped to the theme color dk1 as defined in the document's theme part. This requirement would be specified using the following WordprocessingML in the document settings:

<w:clrSchemeMapping w:accent3="dark1" />

The accent3 attribute has a value of dark1, specifying that uses of the theme color value accent3 must be mapped to the theme color dk1. end example]

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

accent4 (Accent4 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the accent4 theme color shall be used.

[Example: Consider a WordprocessingML document that must have references to the theme color accent4 mapped to the theme color dk2 as defined in the document's theme part. This requirement would be specified using the following WordprocessingML in the document settings:

<w:clrSchemeMapping w:accent4="dark2" />

The accent4 attribute has a value of dark2, specifying that uses of the theme color value accent3 must be mapped to the theme color dk2. end example]

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

accent5 (Accent5 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the accent5 theme color shall be used.

[Example: Consider a WordprocessingML document that must have references to the theme color accent5 mapped to the theme color accent1 as defined in the document's theme part. This requirement would be specified using the following WordprocessingML in the document settings:

<w:clrSchemeMapping w:accent5="accent1" />

The accent5 attribute has a value of accent1, specifying that uses of the theme color value accent5 must be mapped to the theme color accent1. end example]

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

accent6 (Accent6 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the accent6 theme color shall be used.

[Example: Consider a WordprocessingML document that must have references to the theme color accent6 mapped to the theme color accent1 as defined in the document's theme part. This requirement would be specified using the following WordprocessingML in the document settings:

<w:clrSchemeMapping w:accent6="accent1" />

The accent6 attribute has a value of accent1, specifying that uses of the theme color value accent6 must be mapped to the theme color accent1. end example]

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

bg1 (Background 1 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the light1 theme color shall be used.

[Example: Consider a WordprocessingML document that must have references to the theme color bg1 mapped to the theme color lt2 as defined in the document's theme part. This requirement would be specified using the following WordprocessingML in the document settings:

<w:clrSchemeMapping w:bg1="light2" />

The bg1 attribute has a value of light2, specifying that uses of the theme color value bg1 must be mapped to the theme color lt2. end example]

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

bg2 (Background 2 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the light2 theme color shall be used.

[Example: Consider a WordprocessingML document that must have references to the theme color bg2 mapped to the theme color dk1 as defined in the document's theme part. This requirement would be specified using the following WordprocessingML in the document settings:

<w:clrSchemeMapping w:bg2="dark1" />

The bg2 attribute has a value of dark1, specifying that uses of the theme color value bg2 must be mapped to the theme color dk1. end example]

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

followedHyperlink (Followed Hyperlink Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the followedHyperlink theme color shall be used.

[Example: Consider a WordprocessingML document that must have references to the theme color followedHyperlink mapped to the theme color hyperlink as defined in the document's theme part. This requirement would be specified using the following WordprocessingML in the document settings:

<w:clrSchemeMapping w:followedHyperlink="hyperlink" />

The followedHyperlink attribute has a value of hyperlink, specifying that uses of the theme color value followedHyperlink must be mapped to the theme color hyperlink. end example]

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

hyperlink (Hyperlink Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the hyperlink theme color shall be used.

[Example: Consider a WordprocessingML document that must have references to the theme color hyperlink mapped to the theme color accent1 as defined in the document's theme part. This requirement would be specified using the following WordprocessingML in the document settings:

<w:clrSchemeMapping w:hyperlink="accent1" />

The hyperlink attribute has a value of accent1, specifying that uses of the theme color value hyperlink must be mapped to the theme color accent1. end example]

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

t1 (Text 1 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the t1 theme color shall be used.

[Example: Consider a WordprocessingML document that must have references to the theme color t1 mapped to the theme color lt1 as defined in the document's theme part. This requirement would be specified using the following WordprocessingML in the document settings:

<w:clrSchemeMapping w:t1="light1" />

The t1 attribute has a value of light1, specifying that uses of the theme color value t1 must be mapped to the theme color lt1. end example]

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

t2 (Text 2 Theme Color Mapping)

Specifies the theme color in the document's theme part which shall be used in place of this color when it is referenced by document content.

If this attribute is omitted, then the t2 theme color shall be used.

[Example: Consider a WordprocessingML document that must have references to the theme color t2 mapped to the theme color dk1 as defined in the document's theme part. This requirement would be specified using the following WordprocessingML in the document settings:

<w:clrSchemeMapping w:t2="dark1" />

The t2 attribute has a value of dark1, specifying that uses of the theme color value t2 must be mapped to the theme color dk1. end example]

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

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

© ISO/IEC29500: 2008.

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

ColorSchemeMapping Members

DocumentFormat.OpenXml.Wordprocessing Namespace