style

style

Enumerations related to styles.

WD_BUILTIN_STYLE

Bases: BaseEnum

Alias: WD_STYLE

Specifies a built-in Microsoft Word style.

Example:

from docx import Document
from docx.enum.style import WD_STYLE

document = Document()
styles = document.styles
style = styles[WD_STYLE.BODY_TEXT]

MS API name: WdBuiltinStyle

http://msdn.microsoft.com/en-us/library/office/ff835210.aspx

BLOCK_QUOTATION class-attribute instance-attribute

BLOCK_QUOTATION = (-85, 'Block Text.')

Block Text.

BODY_TEXT class-attribute instance-attribute

BODY_TEXT = (-67, 'Body Text.')

Body Text.

BODY_TEXT_2 class-attribute instance-attribute

BODY_TEXT_2 = (-81, 'Body Text 2.')

Body Text 2.

BODY_TEXT_3 class-attribute instance-attribute

BODY_TEXT_3 = (-82, 'Body Text 3.')

Body Text 3.

BODY_TEXT_FIRST_INDENT class-attribute instance-attribute

BODY_TEXT_FIRST_INDENT = (-78, 'Body Text First Indent.')

Body Text First Indent.

BODY_TEXT_FIRST_INDENT_2 class-attribute instance-attribute

BODY_TEXT_FIRST_INDENT_2 = (
    -79,
    "Body Text First Indent 2.",
)

Body Text First Indent 2.

BODY_TEXT_INDENT class-attribute instance-attribute

BODY_TEXT_INDENT = (-68, 'Body Text Indent.')

Body Text Indent.

BODY_TEXT_INDENT_2 class-attribute instance-attribute

BODY_TEXT_INDENT_2 = (-83, 'Body Text Indent 2.')

Body Text Indent 2.

BODY_TEXT_INDENT_3 class-attribute instance-attribute

BODY_TEXT_INDENT_3 = (-84, 'Body Text Indent 3.')

Body Text Indent 3.

BOOK_TITLE class-attribute instance-attribute

BOOK_TITLE = (-265, 'Book Title.')

Book Title.

CAPTION class-attribute instance-attribute

CAPTION = (-35, 'Caption.')

Caption.

CLOSING class-attribute instance-attribute

CLOSING = (-64, 'Closing.')

Closing.

COMMENT_REFERENCE class-attribute instance-attribute

COMMENT_REFERENCE = (-40, 'Comment Reference.')

Comment Reference.

COMMENT_TEXT class-attribute instance-attribute

COMMENT_TEXT = (-31, 'Comment Text.')

Comment Text.

DATE class-attribute instance-attribute

DATE = (-77, 'Date.')

Date.

DEFAULT_PARAGRAPH_FONT class-attribute instance-attribute

DEFAULT_PARAGRAPH_FONT = (-66, 'Default Paragraph Font.')

Default Paragraph Font.

EMPHASIS class-attribute instance-attribute

EMPHASIS = (-89, 'Emphasis.')

Emphasis.

ENDNOTE_REFERENCE class-attribute instance-attribute

ENDNOTE_REFERENCE = (-43, 'Endnote Reference.')

Endnote Reference.

ENDNOTE_TEXT class-attribute instance-attribute

ENDNOTE_TEXT = (-44, 'Endnote Text.')

Endnote Text.

ENVELOPE_ADDRESS class-attribute instance-attribute

ENVELOPE_ADDRESS = (-37, 'Envelope Address.')

Envelope Address.

ENVELOPE_RETURN class-attribute instance-attribute

ENVELOPE_RETURN = (-38, 'Envelope Return.')

Envelope Return.

FOOTER class-attribute instance-attribute

FOOTER = (-33, 'Footer.')

Footer.

FOOTNOTE_REFERENCE class-attribute instance-attribute

FOOTNOTE_REFERENCE = (-39, 'Footnote Reference.')

Footnote Reference.

FOOTNOTE_TEXT class-attribute instance-attribute

FOOTNOTE_TEXT = (-30, 'Footnote Text.')

Footnote Text.

HEADER class-attribute instance-attribute

HEADER = (-32, 'Header.')

Header.

HEADING_1 class-attribute instance-attribute

HEADING_1 = (-2, 'Heading 1.')

Heading 1.

HEADING_2 class-attribute instance-attribute

HEADING_2 = (-3, 'Heading 2.')

Heading 2.

HEADING_3 class-attribute instance-attribute

HEADING_3 = (-4, 'Heading 3.')

Heading 3.

HEADING_4 class-attribute instance-attribute

HEADING_4 = (-5, 'Heading 4.')

Heading 4.

HEADING_5 class-attribute instance-attribute

HEADING_5 = (-6, 'Heading 5.')

Heading 5.

HEADING_6 class-attribute instance-attribute

HEADING_6 = (-7, 'Heading 6.')

Heading 6.

HEADING_7 class-attribute instance-attribute

HEADING_7 = (-8, 'Heading 7.')

Heading 7.

HEADING_8 class-attribute instance-attribute

HEADING_8 = (-9, 'Heading 8.')

Heading 8.

HEADING_9 class-attribute instance-attribute

HEADING_9 = (-10, 'Heading 9.')

Heading 9.

HTML_ACRONYM class-attribute instance-attribute

HTML_ACRONYM = (-96, 'HTML Acronym.')

HTML Acronym.

HTML_ADDRESS class-attribute instance-attribute

HTML_ADDRESS = (-97, 'HTML Address.')

HTML Address.

HTML_CITE class-attribute instance-attribute

HTML_CITE = (-98, 'HTML Cite.')

HTML Cite.

HTML_CODE class-attribute instance-attribute

HTML_CODE = (-99, 'HTML Code.')

HTML Code.

HTML_DFN class-attribute instance-attribute

HTML_DFN = (-100, 'HTML Definition.')

HTML Definition.

HTML_KBD class-attribute instance-attribute

HTML_KBD = (-101, 'HTML Keyboard.')

HTML Keyboard.

HTML_NORMAL class-attribute instance-attribute

HTML_NORMAL = (-95, 'Normal (Web).')

Normal (Web).

HTML_PRE class-attribute instance-attribute

HTML_PRE = (-102, 'HTML Preformatted.')

HTML Preformatted.

HTML_SAMP class-attribute instance-attribute

HTML_SAMP = (-103, 'HTML Sample.')

HTML Sample.

HTML_TT class-attribute instance-attribute

HTML_TT = (-104, 'HTML Typewriter.')

HTML Typewriter.

HTML_VAR class-attribute instance-attribute

HTML_VAR = (-105, 'HTML Variable.')

HTML Variable.

HYPERLINK class-attribute instance-attribute

HYPERLINK = (-86, 'Hyperlink.')

Hyperlink.

HYPERLINK_FOLLOWED class-attribute instance-attribute

HYPERLINK_FOLLOWED = (-87, 'Followed Hyperlink.')

Followed Hyperlink.

INDEX_1 class-attribute instance-attribute

INDEX_1 = (-11, 'Index 1.')

Index 1.

INDEX_2 class-attribute instance-attribute

INDEX_2 = (-12, 'Index 2.')

Index 2.

INDEX_3 class-attribute instance-attribute

INDEX_3 = (-13, 'Index 3.')

Index 3.

INDEX_4 class-attribute instance-attribute

INDEX_4 = (-14, 'Index 4.')

Index 4.

INDEX_5 class-attribute instance-attribute

INDEX_5 = (-15, 'Index 5.')

Index 5.

INDEX_6 class-attribute instance-attribute

INDEX_6 = (-16, 'Index 6.')

Index 6.

INDEX_7 class-attribute instance-attribute

INDEX_7 = (-17, 'Index 7.')

Index 7.

INDEX_8 class-attribute instance-attribute

INDEX_8 = (-18, 'Index 8.')

Index 8.

INDEX_9 class-attribute instance-attribute

INDEX_9 = (-19, 'Index 9.')

Index 9.

INDEX_HEADING class-attribute instance-attribute

INDEX_HEADING = (-34, 'Index Heading')

Index Heading

INTENSE_EMPHASIS class-attribute instance-attribute

INTENSE_EMPHASIS = (-262, 'Intense Emphasis.')

Intense Emphasis.

INTENSE_QUOTE class-attribute instance-attribute

INTENSE_QUOTE = (-182, 'Intense Quote.')

Intense Quote.

INTENSE_REFERENCE class-attribute instance-attribute

INTENSE_REFERENCE = (-264, 'Intense Reference.')

Intense Reference.

LINE_NUMBER class-attribute instance-attribute

LINE_NUMBER = (-41, 'Line Number.')

Line Number.

LIST class-attribute instance-attribute

LIST = (-48, 'List.')

List.

LIST_2 class-attribute instance-attribute

LIST_2 = (-51, 'List 2.')

List 2.

LIST_3 class-attribute instance-attribute

LIST_3 = (-52, 'List 3.')

List 3.

LIST_4 class-attribute instance-attribute

LIST_4 = (-53, 'List 4.')

List 4.

LIST_5 class-attribute instance-attribute

LIST_5 = (-54, 'List 5.')

List 5.

LIST_BULLET class-attribute instance-attribute

LIST_BULLET = (-49, 'List Bullet.')

List Bullet.

LIST_BULLET_2 class-attribute instance-attribute

LIST_BULLET_2 = (-55, 'List Bullet 2.')

List Bullet 2.

LIST_BULLET_3 class-attribute instance-attribute

LIST_BULLET_3 = (-56, 'List Bullet 3.')

List Bullet 3.

LIST_BULLET_4 class-attribute instance-attribute

LIST_BULLET_4 = (-57, 'List Bullet 4.')

List Bullet 4.

LIST_BULLET_5 class-attribute instance-attribute

LIST_BULLET_5 = (-58, 'List Bullet 5.')

List Bullet 5.

LIST_CONTINUE class-attribute instance-attribute

LIST_CONTINUE = (-69, 'List Continue.')

List Continue.

LIST_CONTINUE_2 class-attribute instance-attribute

LIST_CONTINUE_2 = (-70, 'List Continue 2.')

List Continue 2.

LIST_CONTINUE_3 class-attribute instance-attribute

LIST_CONTINUE_3 = (-71, 'List Continue 3.')

List Continue 3.

LIST_CONTINUE_4 class-attribute instance-attribute

LIST_CONTINUE_4 = (-72, 'List Continue 4.')

List Continue 4.

LIST_CONTINUE_5 class-attribute instance-attribute

LIST_CONTINUE_5 = (-73, 'List Continue 5.')

List Continue 5.

LIST_NUMBER class-attribute instance-attribute

LIST_NUMBER = (-50, 'List Number.')

List Number.

LIST_NUMBER_2 class-attribute instance-attribute

LIST_NUMBER_2 = (-59, 'List Number 2.')

List Number 2.

LIST_NUMBER_3 class-attribute instance-attribute

LIST_NUMBER_3 = (-60, 'List Number 3.')

List Number 3.

LIST_NUMBER_4 class-attribute instance-attribute

LIST_NUMBER_4 = (-61, 'List Number 4.')

List Number 4.

LIST_NUMBER_5 class-attribute instance-attribute

LIST_NUMBER_5 = (-62, 'List Number 5.')

List Number 5.

LIST_PARAGRAPH class-attribute instance-attribute

LIST_PARAGRAPH = (-180, 'List Paragraph.')

List Paragraph.

MACRO_TEXT class-attribute instance-attribute

MACRO_TEXT = (-46, 'Macro Text.')

Macro Text.

MESSAGE_HEADER class-attribute instance-attribute

MESSAGE_HEADER = (-74, 'Message Header.')

Message Header.

NAV_PANE class-attribute instance-attribute

NAV_PANE = (-90, 'Document Map.')

Document Map.

NORMAL class-attribute instance-attribute

NORMAL = (-1, 'Normal.')

Normal.

NORMAL_INDENT class-attribute instance-attribute

NORMAL_INDENT = (-29, 'Normal Indent.')

Normal Indent.

NORMAL_OBJECT class-attribute instance-attribute

NORMAL_OBJECT = (-158, 'Normal (applied to an object).')

Normal (applied to an object).

NORMAL_TABLE class-attribute instance-attribute

NORMAL_TABLE = (-106, 'Normal (applied within a table).')

Normal (applied within a table).

NOTE_HEADING class-attribute instance-attribute

NOTE_HEADING = (-80, 'Note Heading.')

Note Heading.

PAGE_NUMBER class-attribute instance-attribute

PAGE_NUMBER = (-42, 'Page Number.')

Page Number.

PLAIN_TEXT class-attribute instance-attribute

PLAIN_TEXT = (-91, 'Plain Text.')

Plain Text.

QUOTE class-attribute instance-attribute

QUOTE = (-181, 'Quote.')

Quote.

SALUTATION class-attribute instance-attribute

SALUTATION = (-76, 'Salutation.')

Salutation.

SIGNATURE class-attribute instance-attribute

SIGNATURE = (-65, 'Signature.')

Signature.

STRONG class-attribute instance-attribute

STRONG = (-88, 'Strong.')

Strong.

SUBTITLE class-attribute instance-attribute

SUBTITLE = (-75, 'Subtitle.')

Subtitle.

SUBTLE_EMPHASIS class-attribute instance-attribute

SUBTLE_EMPHASIS = (-261, 'Subtle Emphasis.')

Subtle Emphasis.

SUBTLE_REFERENCE class-attribute instance-attribute

SUBTLE_REFERENCE = (-263, 'Subtle Reference.')

Subtle Reference.

TABLE_COLORFUL_GRID class-attribute instance-attribute

TABLE_COLORFUL_GRID = (-172, 'Colorful Grid.')

Colorful Grid.

TABLE_COLORFUL_LIST class-attribute instance-attribute

TABLE_COLORFUL_LIST = (-171, 'Colorful List.')

Colorful List.

TABLE_COLORFUL_SHADING class-attribute instance-attribute

TABLE_COLORFUL_SHADING = (-170, 'Colorful Shading.')

Colorful Shading.

TABLE_DARK_LIST class-attribute instance-attribute

TABLE_DARK_LIST = (-169, 'Dark List.')

Dark List.

TABLE_LIGHT_GRID class-attribute instance-attribute

TABLE_LIGHT_GRID = (-161, 'Light Grid.')

Light Grid.

TABLE_LIGHT_GRID_ACCENT_1 class-attribute instance-attribute

TABLE_LIGHT_GRID_ACCENT_1 = (-175, 'Light Grid Accent 1.')

Light Grid Accent 1.

TABLE_LIGHT_LIST class-attribute instance-attribute

TABLE_LIGHT_LIST = (-160, 'Light List.')

Light List.

TABLE_LIGHT_LIST_ACCENT_1 class-attribute instance-attribute

TABLE_LIGHT_LIST_ACCENT_1 = (-174, 'Light List Accent 1.')

Light List Accent 1.

TABLE_LIGHT_SHADING class-attribute instance-attribute

TABLE_LIGHT_SHADING = (-159, 'Light Shading.')

Light Shading.

TABLE_LIGHT_SHADING_ACCENT_1 class-attribute instance-attribute

TABLE_LIGHT_SHADING_ACCENT_1 = (
    -173,
    "Light Shading Accent 1.",
)

Light Shading Accent 1.

TABLE_MEDIUM_GRID_1 class-attribute instance-attribute

TABLE_MEDIUM_GRID_1 = (-166, 'Medium Grid 1.')

Medium Grid 1.

TABLE_MEDIUM_GRID_2 class-attribute instance-attribute

TABLE_MEDIUM_GRID_2 = (-167, 'Medium Grid 2.')

Medium Grid 2.

TABLE_MEDIUM_GRID_3 class-attribute instance-attribute

TABLE_MEDIUM_GRID_3 = (-168, 'Medium Grid 3.')

Medium Grid 3.

TABLE_MEDIUM_LIST_1 class-attribute instance-attribute

TABLE_MEDIUM_LIST_1 = (-164, 'Medium List 1.')

Medium List 1.

TABLE_MEDIUM_LIST_1_ACCENT_1 class-attribute instance-attribute

TABLE_MEDIUM_LIST_1_ACCENT_1 = (
    -178,
    "Medium List 1 Accent 1.",
)

Medium List 1 Accent 1.

TABLE_MEDIUM_LIST_2 class-attribute instance-attribute

TABLE_MEDIUM_LIST_2 = (-165, 'Medium List 2.')

Medium List 2.

TABLE_MEDIUM_SHADING_1 class-attribute instance-attribute

TABLE_MEDIUM_SHADING_1 = (-162, 'Medium Shading 1.')

Medium Shading 1.

TABLE_MEDIUM_SHADING_1_ACCENT_1 class-attribute instance-attribute

TABLE_MEDIUM_SHADING_1_ACCENT_1 = (
    -176,
    "Medium Shading 1 Accent 1.",
)

Medium Shading 1 Accent 1.

TABLE_MEDIUM_SHADING_2 class-attribute instance-attribute

TABLE_MEDIUM_SHADING_2 = (-163, 'Medium Shading 2.')

Medium Shading 2.

TABLE_MEDIUM_SHADING_2_ACCENT_1 class-attribute instance-attribute

TABLE_MEDIUM_SHADING_2_ACCENT_1 = (
    -177,
    "Medium Shading 2 Accent 1.",
)

Medium Shading 2 Accent 1.

TABLE_OF_AUTHORITIES class-attribute instance-attribute

TABLE_OF_AUTHORITIES = (-45, 'Table of Authorities.')

Table of Authorities.

TABLE_OF_FIGURES class-attribute instance-attribute

TABLE_OF_FIGURES = (-36, 'Table of Figures.')

Table of Figures.

TITLE class-attribute instance-attribute

TITLE = (-63, 'Title.')

Title.

TOAHEADING class-attribute instance-attribute

TOAHEADING = (-47, 'TOA Heading.')

TOA Heading.

TOC_1 class-attribute instance-attribute

TOC_1 = (-20, 'TOC 1.')

TOC 1.

TOC_2 class-attribute instance-attribute

TOC_2 = (-21, 'TOC 2.')

TOC 2.

TOC_3 class-attribute instance-attribute

TOC_3 = (-22, 'TOC 3.')

TOC 3.

TOC_4 class-attribute instance-attribute

TOC_4 = (-23, 'TOC 4.')

TOC 4.

TOC_5 class-attribute instance-attribute

TOC_5 = (-24, 'TOC 5.')

TOC 5.

TOC_6 class-attribute instance-attribute

TOC_6 = (-25, 'TOC 6.')

TOC 6.

TOC_7 class-attribute instance-attribute

TOC_7 = (-26, 'TOC 7.')

TOC 7.

TOC_8 class-attribute instance-attribute

TOC_8 = (-27, 'TOC 8.')

TOC 8.

TOC_9 class-attribute instance-attribute

TOC_9 = (-28, 'TOC 9.')

TOC 9.

WD_STYLE_TYPE

Bases: BaseXmlEnum

Specifies one of the four style types: paragraph, character, list, or table.

Example:

from docx import Document
from docx.enum.style import WD_STYLE_TYPE

styles = Document().styles
assert styles[0].type == WD_STYLE_TYPE.PARAGRAPH

MS API name: WdStyleType

http://msdn.microsoft.com/en-us/library/office/ff196870.aspx

CHARACTER class-attribute instance-attribute

CHARACTER = (2, 'character', 'Character style.')

Character style.

LIST class-attribute instance-attribute

LIST = (4, 'numbering', 'List style.')

List style.

PARAGRAPH class-attribute instance-attribute

PARAGRAPH = (1, 'paragraph', 'Paragraph style.')

Paragraph style.

TABLE class-attribute instance-attribute

TABLE = (3, 'table', 'Table style.')

Table style.