PortionFormat

PortionFormat class

This class contains the text portion formatting properties. Unlike IPortionFormatEffectiveData, all properties of this class are writeable. 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#getEffective method which returns a IPortionFormatEffectiveData instance.

PortionFormat

NameDescription
PortionFormat()Initializes a new instance of PortionFormat class.

Returns: PortionFormat


getBookmarkId

NameDescription
getBookmarkId ()Returns or sets bookmark identifier. Read/write String.

Returns: String


getEffective

NameDescription
getEffective ()Gets effective portion formatting data with the inheritance applied.

Returns: PortionFormatEffectiveData


getHyperlinkClick

NameDescription
getHyperlinkClick ()Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink.

Returns: Hyperlink


getHyperlinkManager

NameDescription
getHyperlinkManager ()Hyperlinks manager. Read-only IHyperlinkManager.

Returns: HyperlinkManager


getHyperlinkMouseOver

NameDescription
getHyperlinkMouseOver ()Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink.

Returns: Hyperlink


getSmartTagClean

NameDescription
getSmartTagClean ()Determines whether the smart tag should be cleaned. No inheritance applied. Read/write boolean.

Returns: boolean


setBookmarkId

NameDescription
setBookmarkId (String)Returns or sets bookmark identifier. Read/write String.

Returns: void


setHyperlinkClick

NameDescription
setHyperlinkClick (Hyperlink)Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink.

Returns: void


setHyperlinkMouseOver

NameDescription
setHyperlinkMouseOver (Hyperlink)Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink.

Returns: void


setSmartTagClean

NameDescription
setSmartTagClean (boolean)Determines whether the smart tag should be cleaned. No inheritance applied. Read/write boolean.

Returns: void