CharacterFormat module

class CharacterFormat.CharacterFormat

Bases: WordAttrCollection

Represents the character formatting in a document.

property AllCaps: bool

Gets the AllCaps property of the text.

Returns:: The AllCaps property of the text.
Return type:: bool

property Bidi: bool

Gets the right-to-left property of the text.

Returns:: The right-to-left property of the text.
Return type:: bool

property Bold: bool: Gets bold style.

property BoldBidi: bool

Gets the bold property for right-to-left text.

Returns:: The bold property for right-to-left text.
Return type:: bool

property Border: Border: Gets the border.

property CharacterSpacing: float: Gets character spacing.

ClearBackground(): Clears the text background.

ClearFormatting(): Clears the formatting of the character.

property DoubleStrike: bool: Gets double strikeout style.

property Emboss: bool

Gets the emboss property of the text.

Returns:: The emboss property of the text.
Return type:: bool

property EmphasisMark: Emphasis: Gets text emphasis mark

property Engrave: bool

Gets the Engrave property of the text.

Returns:: The Engrave property of the text.
Return type:: bool

property FontName: str: Returns or sets font name.

property FontNameAscii: str: Gets or sets the font used for Latin text (characters with character codes from 0 through 127).

property FontNameBidi: str: Gets or sets the font name for right-to-left text.

property FontNameFarEast: str: Gets or sets the East Asian font name.

property FontNameNonFarEast: str: Gets or sets the font used for characters with character codes from 128 through 255.

property FontSize: float: Returns or sets font size.

property FontSizeBidi: float: Gets or sets the font size of the right-to-left text.

property FontTypeHint: FontTypeHint: Gets or sets the font type hint.

property Hidden: bool

Gets the Hidden property of the text.

Returns:: The Hidden property of the text.
Return type:: bool

property HighlightColor: Color: Gets or sets the highlight color of the text.

property IsOutLine: bool: Gets or sets the outline character property.

property IsShadow: bool

Gets the shadow property of the text.

Returns:: The shadow property of the text.
Return type:: bool

property IsSmallCaps: bool

Gets the IsSmallCaps property of the text.

Returns:: The IsSmallCaps property of the text.
Return type:: bool

property IsStrikeout: bool: Gets strikeout style.

property Italic: bool: Gets italic style.

property ItalicBidi: bool: Gets or sets the italic property for right-to-left text.

property LigaturesType: LigatureType: Gets or sets the ligatures type.

property LocaleIdASCII: Int16: Gets or sets the ASCII locale id.

property LocaleIdFarEast: Int16: Gets or sets the far east locale id.

property NumberFormType: NumberFormType: Gets or sets the number form type.

property NumberSpaceType: NumberSpaceType: Gets or sets the number space type.

property Position: float: Gets position.

property StylisticSetType: StylisticSetType: Gets or sets the stylistic set type.

property SubSuperScript: SubSuperScript: Gets subscript or superscript style.

property TextBackgroundColor: Color: Gets text background color.

property TextColor: Color: Gets text color

property TextEffectFormat: TextEffectFormat

<summary>: Returns text effect format

</summary>

property TextScale: Int16: Returns or sets a value specifies that the percentage by which the contents of a run shall be expanded or compressed with respect to its normal(100%) character width,with a minimun width of 1% and maximum width of 600%.

property UnderlineStyle: UnderlineStyle: Gets underline style.