IPortionFormat class

This class contains the text portion formatting properties. Unlike IPortionFormatEffectiveData, all properties of this class are writeable.

The IPortionFormat type exposes the following members:

Properties

Property	Description
`bookmark_id`	Returns or sets bookmark identifier. Read/write str.
`smart_tag_clean`	Determines whether the smart tag should be cleaned. No inheritance applied. Read/write bool.
`line_format`
`fill_format`
`effect_format`
`highlight_color`
`underline_line_format`
`underline_fill_format`
`font_bold`
`font_italic`
`kumimoji`
`normalise_height`
`proof_disabled`
`font_underline`
`text_cap_type`
`strikethrough_type`
`is_hard_underline_line`
`is_hard_underline_fill`
`font_height`
`latin_font`
`east_asian_font`
`complex_script_font`
`symbol_font`
`escapement`
`kerning_minimal_size`
`language_id`
`alternative_language_id`
`spacing`
`hyperlink_click`
`hyperlink_mouse_over`
`hyperlink_manager`

Methods

Method	Description
`get_effective`	Gets effective portion formatting data with the inheritance applied.

Remarks

This class is used to return and manipulate text portion formatting properties defined for the particular portion. This means that no inheritance is applied when getting values so for the majority of cases you will get values meaning “undefined”.

In order to get the effective formatting parameter values including inherited you need to use IPortionFormat.get_effective method which returns a IPortionFormatEffectiveData instance.

IPortionFormat class

IPortionFormat class

Properties

Methods

Remarks

See Also