PortionFormat class

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

Inheritance:PortionFormat → BasePortionFormat → PVIObject

The PortionFormat type exposes the following members:

Constructors

Constructor	Description
`__init__`	Initializes a new instance of `PortionFormat` class.

Properties

Property	Description
`line_format`	Returns the LineFormat properties for text outlining. No inheritance applied. Read-only `ILineFormat`.
`fill_format`	Returns the text FillFormat properties. No inheritance applied. Read-only `IFillFormat`.
`effect_format`	Returns the text EffectFormat properties. No inheritance applied. Read-only `IEffectFormat`.
`highlight_color`	Returns the color used to highlight a text. No inheritance applied. Read-only `IColorFormat`.
`underline_line_format`	Returns the LineFormat properties used to outline underline line. No inheritance applied. Read-only `ILineFormat`.
`underline_fill_format`	Returns the underline line FillFormat properties. No inheritance applied. Read-only `IFillFormat`.
`font_bold`	Determines whether the font is bold. No inheritance applied. Read/write `NullableBool`.
`font_italic`	Determines whether the font is itallic. No inheritance applied. Read/write `NullableBool`.
`kumimoji`	Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Read/write `NullableBool`.
`normalise_height`	Determines whether the height of a text should be normalized. No inheritance applied. Read/write `NullableBool`.
`proof_disabled`	Determines whether the text shouldn’t be proofed. No inheritance applied. Read/write `NullableBool`.
`font_underline`	Returns or sets the text underline type. No inheritance applied. Read/write `TextUnderlineType`.
`text_cap_type`	Returns or sets the type of text capitalization. No inheritance applied. Read/write `TextCapType`.
`strikethrough_type`	Returns or sets the strikethrough type of a text. No inheritance applied. Read/write `TextStrikethroughType`.
`is_hard_underline_line`	Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Read/write `NullableBool`.
`is_hard_underline_fill`	Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Read/write `NullableBool`.
`font_height`	Returns or sets the font height of a portion. float.NaN means height is undefined and should be inherited from the Master. Read/write float.
`latin_font`	Returns or sets the Latin font info. Null means font is undefined and should be inherited from the Master. Read/write `IFontData`.
`east_asian_font`	Returns or sets the East Asian font info. Null means font is undefined and should be inherited from the Master. Read/write `IFontData`.
`complex_script_font`	Returns or sets the complex script font info. Null means font is undefined and should be inherited from the Master. Read/write `IFontData`.
`symbol_font`	Returns or sets the symbolic font info. Null means font is undefined and should be inherited from the Master. Read/write `IFontData`.
`escapement`	Returns or sets the superscript or subscript text. Value from -100% (subscript) to 100% (superscript). float.NaN means value is undefined and should be inherited from the Master. Read/write float.
`kerning_minimal_size`	Returns or sets the minimal font size, for which kerning should be switched on. float.NaN means value is undefined and should be inherited from the Master. Read/write float.
`language_id`	Returns or sets the Id of a proofing language. Used for checking spelling and grammar. Read/write str.
`alternative_language_id`	Returns or sets the Id of an alternative language. Read/write str.
`spacing`	Returns or sets the intercharacter spacing increment. float.NaN means value is undefined and should be inherited from the Master. Read/write float.
`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.
`hyperlink_click`	Returns or sets the hyperlink defined for mouse click. Read/write `IHyperlink`.
`hyperlink_mouse_over`	Returns or sets the hyperlink defined for mouse over. Read/write `IHyperlink`.
`hyperlink_manager`	Hyperlinks manager. Read-only `IHyperlinkManager`.
`slide`
`presentation`

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 PortionFormat.get_effective method which returns a IPortionFormatEffectiveData instance.

PortionFormat class

PortionFormat class

Constructors

Properties

Methods

Remarks

See Also