Paper Office
paper-pptxAPI referenceenum.text

MSO_TEXT_UNDERLINE_TYPE

paper-pptx 0.2.0 API reference

Indicates the type of underline for text. Used with :attr:.Font.underline to specify the style of text underlining.

Alias: MSO_UNDERLINE

Example::

from pptx.enum.text import MSO_UNDERLINE

run.font.underline = MSO_UNDERLINE.DOUBLE_LINE

MS API Name: MsoTextUnderlineType

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

Attributes

DASH_HEAVY_LINE

attributeDASH_HEAVY_LINE
= (8, 'dashHeavy', 'Specifies a dash underline.')

Specifies a dash underline.

DASH_LINE

attributeDASH_LINE
= (7, 'dash', 'Specifies a dash line underline.')

Specifies a dash line underline.

DASH_LONG_HEAVY_LINE

attributeDASH_LONG_HEAVY_LINE
= (10, 'dashLongHeavy', 'Specifies a long heavy line underline.')

Specifies a long heavy line underline.

DASH_LONG_LINE

attributeDASH_LONG_LINE
= (9, 'dashLong', 'Specifies a dashed long line underline.')

Specifies a dashed long line underline.

DOTTED_HEAVY_LINE

attributeDOTTED_HEAVY_LINE
= (6, 'dottedHeavy', 'Specifies a dotted heavy line underline.')

Specifies a dotted heavy line underline.

DOTTED_LINE

attributeDOTTED_LINE
= (5, 'dotted', 'Specifies a dotted line underline.')

Specifies a dotted line underline.

DOT_DASH_HEAVY_LINE

attributeDOT_DASH_HEAVY_LINE
= (12, 'dotDashHeavy', 'Specifies a dot dash heavy line underline.')

Specifies a dot dash heavy line underline.

DOT_DASH_LINE

attributeDOT_DASH_LINE
= (11, 'dotDash', 'Specifies a dot dash line underline.')

Specifies a dot dash line underline.

DOT_DOT_DASH_HEAVY_LINE

attributeDOT_DOT_DASH_HEAVY_LINE
= (14, 'dotDotDashHeavy', 'Specifies a dot dot dash heavy line underline.')

Specifies a dot dot dash heavy line underline.

DOT_DOT_DASH_LINE

attributeDOT_DOT_DASH_LINE
= (13, 'dotDotDash', 'Specifies a dot dot dash line underline.')

Specifies a dot dot dash line underline.

DOUBLE_LINE

attributeDOUBLE_LINE
= (3, 'dbl', 'Specifies a double line underline.')

Specifies a double line underline.

HEAVY_LINE

attributeHEAVY_LINE
= (4, 'heavy', 'Specifies a heavy line underline.')

Specifies a heavy line underline.

MIXED

attributeMIXED
= (-2, '', 'Specifies a mix of underline types (read-only).')

Specifies a mix of underline types (read-only).

NONE

attributeNONE
= (0, 'none', 'Specifies no underline.')

Specifies no underline.

SINGLE_LINE

attributeSINGLE_LINE
= (2, 'sng', 'Specifies a single line underline.')

Specifies a single line underline.

WAVY_DOUBLE_LINE

attributeWAVY_DOUBLE_LINE
= (17, 'wavyDbl', 'Specifies a wavy double line underline.')

Specifies a wavy double line underline.

WAVY_HEAVY_LINE

attributeWAVY_HEAVY_LINE
= (16, 'wavyHeavy', 'Specifies a wavy heavy line underline.')

Specifies a wavy heavy line underline.

WAVY_LINE

attributeWAVY_LINE
= (15, 'wavy', 'Specifies a wavy line underline.')

Specifies a wavy line underline.

WORDS

attributeWORDS
= (1, 'words', 'Specifies underlining words.')

Specifies underlining words.

xml_value

attributexml_valuestr | None

Functions

from_xml

funcfrom_xml(xml_value: str) -> Self

Enumeration member corresponding to XML attribute value xml_value.

Raises ValueError if xml_value is the empty string ("") or is not an XML attribute value registered on the enumeration. Note that enum members that do not correspond to one of the defined values for an XML attribute have xml_value == "". These "return-value only" members cannot be automatically mapped from an XML attribute value and must be selected explicitly by code, based on the appropriate conditions.

Example::

WD_PARAGRAPH_ALIGNMENT.from_xml("center") WD_PARAGRAPH_ALIGNMENT.CENTER

paramxml_valuestr

Returns

typing_extensions.Self

to_xml

functo_xml(value: int | _T) -> str

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

paramvalueint | _T

Returns

str

validate

funcvalidate(value: _T)

Raise ValueError if value is not an assignable value.

paramvalue_T

On this page