Paper Office
paper-docxAPI referenceenum.dml

MSO_THEME_COLOR_INDEX

paper-docx 0.2.0 API reference

Indicates the Office theme color, one of those shown in the color gallery on the formatting ribbon.

Alias: MSO_THEME_COLOR

Example::

from docx.enum.dml import MSO_THEME_COLOR

font.color.theme_color = MSO_THEME_COLOR.ACCENT_1

MS API name: MsoThemeColorIndex

http://msdn.microsoft.com/en-us/library/office/ff860782(v=office.15).aspx

Attributes

ACCENT_1

attributeACCENT_1
= (5, 'accent1', 'Specifies the Accent 1 theme color.')

Specifies the Accent 1 theme color.

ACCENT_2

attributeACCENT_2
= (6, 'accent2', 'Specifies the Accent 2 theme color.')

Specifies the Accent 2 theme color.

ACCENT_3

attributeACCENT_3
= (7, 'accent3', 'Specifies the Accent 3 theme color.')

Specifies the Accent 3 theme color.

ACCENT_4

attributeACCENT_4
= (8, 'accent4', 'Specifies the Accent 4 theme color.')

Specifies the Accent 4 theme color.

ACCENT_5

attributeACCENT_5
= (9, 'accent5', 'Specifies the Accent 5 theme color.')

Specifies the Accent 5 theme color.

ACCENT_6

attributeACCENT_6
= (10, 'accent6', 'Specifies the Accent 6 theme color.')

Specifies the Accent 6 theme color.

BACKGROUND_1

attributeBACKGROUND_1
= (14, 'background1', 'Specifies the Background 1 theme color.')

Specifies the Background 1 theme color.

BACKGROUND_2

attributeBACKGROUND_2
= (16, 'background2', 'Specifies the Background 2 theme color.')

Specifies the Background 2 theme color.

DARK_1

attributeDARK_1
= (1, 'dark1', 'Specifies the Dark 1 theme color.')

Specifies the Dark 1 theme color.

DARK_2

attributeDARK_2
= (3, 'dark2', 'Specifies the Dark 2 theme color.')

Specifies the Dark 2 theme color.

attributeFOLLOWED_HYPERLINK
= (12, 'followedHyperlink', 'Specifies the theme color for a clicked hyperlink.')

Specifies the theme color for a clicked hyperlink.

attributeHYPERLINK
= (11, 'hyperlink', 'Specifies the theme color for a hyperlink.')

Specifies the theme color for a hyperlink.

LIGHT_1

attributeLIGHT_1
= (2, 'light1', 'Specifies the Light 1 theme color.')

Specifies the Light 1 theme color.

LIGHT_2

attributeLIGHT_2
= (4, 'light2', 'Specifies the Light 2 theme color.')

Specifies the Light 2 theme color.

NOT_THEME_COLOR

attributeNOT_THEME_COLOR
= (0, 'UNMAPPED', 'Indicates the color is not a theme color.')

Indicates the color is not a theme color.

TEXT_1

attributeTEXT_1
= (13, 'text1', 'Specifies the Text 1 theme color.')

Specifies the Text 1 theme color.

TEXT_2

attributeTEXT_2
= (15, 'text2', 'Specifies the Text 2 theme color.')

Specifies the Text 2 theme color.

xml_value

attributexml_valuestr | None

Functions

from_xml

funcfrom_xml(xml_value: str | None) -> Self

Enumeration member corresponding to XML attribute value xml_value.

Example::

WD_PARAGRAPH_ALIGNMENT.from_xml("center") WD_PARAGRAPH_ALIGNMENT.CENTER

paramxml_valuestr | None

Returns

typing_extensions.Self

to_xml

functo_xml(value: int | _T | None) -> str | None

XML value of this enum member, generally an XML attribute value.

paramvalueint | _T | None

Returns

str | None

On this page