PortionFormat
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.
| Name | Description |
|---|
| PortionFormat() | Initializes a new instance of PortionFormat class. |
Returns:
PortionFormat
getBookmarkId
| Name | Description |
|---|
| getBookmarkId () | Returns or sets bookmark identifier. Read/write String. |
Returns:
String
getEffective
| Name | Description |
|---|
| getEffective () | Gets effective portion formatting data with the inheritance applied. |
Returns:
PortionFormatEffectiveData
getHyperlinkClick
| Name | Description |
|---|
| getHyperlinkClick () | Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink. |
Returns:
Hyperlink
getHyperlinkManager
| Name | Description |
|---|
| getHyperlinkManager () | Hyperlinks manager. Read-only IHyperlinkManager. |
Returns:
HyperlinkManager
getHyperlinkMouseOver
| Name | Description |
|---|
| getHyperlinkMouseOver () | Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink. |
Returns:
Hyperlink
getSmartTagClean
| Name | Description |
|---|
| getSmartTagClean () | Determines whether the smart tag should be cleaned. No inheritance applied. Read/write boolean. |
Returns:
boolean
setBookmarkId
| Name | Description |
|---|
| setBookmarkId (String) | Returns or sets bookmark identifier. Read/write String. |
setHyperlinkClick
| Name | Description |
|---|
| setHyperlinkClick (Hyperlink) | Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink. |
setHyperlinkMouseOver
| Name | Description |
|---|
| setHyperlinkMouseOver (Hyperlink) | Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink. |
setSmartTagClean
| Name | Description |
|---|
| setSmartTagClean (boolean) | Determines whether the smart tag should be cleaned. No inheritance applied. Read/write boolean. |