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

Name	Description
PortionFormat()	Initializes a new instance of PortionFormat class.

Result: PortionFormat

---

getAlternativeLanguageId

Name	Description
getAlternativeLanguageId()	Returns or sets the Id of an alternative language. Read/write String.

Result: String

---

getBookmarkId

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

Result: String

---

getComplexScriptFont

Name	Description
getComplexScriptFont()	Returns or sets the complex script font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.

Result: FontData

---

getEastAsianFont

Name	Description
getEastAsianFont()	Returns or sets the East Asian font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.

Result: FontData

---

getEffectFormat

Name	Description
getEffectFormat()	Returns the text EffectFormat properties. No inheritance applied. Read-only IEffectFormat.

Result: EffectFormat

---

getEffective

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

Result: PortionFormatEffectiveData

---

getEscapement

Name	Description
getEscapement()	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.

Result: float

---

getFillFormat

Name	Description
getFillFormat()	Returns the text FillFormat properties. No inheritance applied. Read-only IFillFormat.

Result: FillFormat

---

getFontBold

Name	Description
getFontBold()	Determines whether the font is bold. No inheritance applied. Read/write NullableBool.

Result: byte

---

getFontHeight

Name	Description
getFontHeight()	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.

Result: float

---

getFontItalic

Name	Description
getFontItalic()	Determines whether the font is itallic. No inheritance applied. Read/write NullableBool.

Result: byte

---

getFontUnderline

Name	Description
getFontUnderline()	Returns or sets the text underline type. No inheritance applied. Read/write TextUnderlineType.

Result: byte

---

getHighlightColor

Name	Description
getHighlightColor()	Returns the color used to highlight a text. No inheritance applied. Read-only IColorFormat.

Result: ColorFormat

---

getHyperlinkClick

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

Result: Hyperlink

---

getHyperlinkManager

Name	Description
getHyperlinkManager()	Hyperlinks manager. Read-only IHyperlinkManager.

Result: HyperlinkManager

---

getHyperlinkMouseOver

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

Result: Hyperlink

---

getKerningMinimalSize

Name	Description
getKerningMinimalSize()	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.

Result: float

---

getKumimoji

Name	Description
getKumimoji()	Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Read/write NullableBool.

Result: byte

---

getLanguageId

Name	Description
getLanguageId()	Returns or sets the Id of a proofing language. Used for checking spelling and grammar. Read/write String.

Result: String

---

getLatinFont

Name	Description
getLatinFont()	Returns or sets the Latin font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.

Result: FontData

---

getLineFormat

Name	Description
getLineFormat()	Returns the LineFormat properties for text outlining. No inheritance applied. Read-only ILineFormat.

Result: LineFormat

---

getNormaliseHeight

Name	Description
getNormaliseHeight()	Determines whether the height of a text should be normalized. No inheritance applied. Read/write NullableBool.

Result: byte

---

getParent_IPresentationComponent

Name	Description
getParent_IPresentationComponent()

---

getParent_ISlideComponent

Name	Description
getParent_ISlideComponent()

---

getParent_Immediate

Name	Description
getParent_Immediate()

---

getPresentation

Name	Description
getPresentation()

Result: Presentation

---

getProofDisabled

Name	Description
getProofDisabled()	Determines whether the text shouldn’t be proofed. No inheritance applied. Read/write NullableBool.

Result: byte

---

getSlide

Name	Description
getSlide()

Result: BaseSlide

---

getSmartTagClean

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

Result: boolean

---

getSpacing

Name	Description
getSpacing()	Returns or sets the intercharacter spacing increment. Float.NaN means value is undefined and should be inherited from the Master. Read/write float.

Result: float

---

getStrikethroughType

Name	Description
getStrikethroughType()	Returns or sets the strikethrough type of a text. No inheritance applied. Read/write TextStrikethroughType.

Result: byte

---

getSymbolFont

Name	Description
getSymbolFont()	Returns or sets the symbolic font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.

Result: FontData

---

getTextCapType

Name	Description
getTextCapType()	Returns or sets the type of text capitalization. No inheritance applied. Read/write TextCapType.

Result: byte

---

getUnderlineFillFormat

Name	Description
getUnderlineFillFormat()	Returns the underline line FillFormat properties. No inheritance applied. Read-only IFillFormat.

Result: FillFormat

---

getUnderlineLineFormat

Name	Description
getUnderlineLineFormat()	Returns the LineFormat properties used to outline underline line. No inheritance applied. Read-only ILineFormat.

Result: LineFormat

---

getVersion

Name	Description
getVersion()

Result: long

---

isHardUnderlineFill

Name	Description
isHardUnderlineFill()	Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Read/write NullableBool.

Result: byte

---

isHardUnderlineLine

Name	Description
isHardUnderlineLine()	Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Read/write NullableBool.

Result: byte

---

setAlternativeLanguageId

Name	Description
setAlternativeLanguageId(String)	Returns or sets the Id of an alternative language. Read/write String.

---

setBookmarkId

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

---

setComplexScriptFont

Name	Description
setComplexScriptFont(FontData)	Returns or sets the complex script font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.

---

setEastAsianFont

Name	Description
setEastAsianFont(FontData)	Returns or sets the East Asian font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.

---

setEscapement

Name	Description
setEscapement(float)	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.

---

setFontBold

Name	Description
setFontBold(byte)	Determines whether the font is bold. No inheritance applied. Read/write NullableBool.

---

setFontHeight

Name	Description
setFontHeight(float)	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.

---

setFontItalic

Name	Description
setFontItalic(byte)	Determines whether the font is itallic. No inheritance applied. Read/write NullableBool.

---

setFontUnderline

Name	Description
setFontUnderline(byte)	Returns or sets the text underline type. No inheritance applied. Read/write TextUnderlineType.

---

setHardUnderlineFill

Name	Description
setHardUnderlineFill(byte)	Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Read/write NullableBool.

---

setHardUnderlineLine

Name	Description
setHardUnderlineLine(byte)	Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Read/write NullableBool.

---

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.

---

setKerningMinimalSize

Name	Description
setKerningMinimalSize(float)	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.

---

setKumimoji

Name	Description
setKumimoji(byte)	Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Read/write NullableBool.

---

setLanguageId

Name	Description
setLanguageId(String)	Returns or sets the Id of a proofing language. Used for checking spelling and grammar. Read/write String.

---

setLatinFont

Name	Description
setLatinFont(FontData)	Returns or sets the Latin font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.

---

setNormaliseHeight

Name	Description
setNormaliseHeight(byte)	Determines whether the height of a text should be normalized. No inheritance applied. Read/write NullableBool.

---

setProofDisabled

Name	Description
setProofDisabled(byte)	Determines whether the text shouldn’t be proofed. No inheritance applied. Read/write NullableBool.

---

setSmartTagClean

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

---

setSpacing

Name	Description
setSpacing(float)	Returns or sets the intercharacter spacing increment. Float.NaN means value is undefined and should be inherited from the Master. Read/write float.

---

setStrikethroughType

Name	Description
setStrikethroughType(byte)	Returns or sets the strikethrough type of a text. No inheritance applied. Read/write TextStrikethroughType.

---

setSymbolFont

Name	Description
setSymbolFont(FontData)	Returns or sets the symbolic font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData.

---

setTextCapType

Name	Description
setTextCapType(byte)	Returns or sets the type of text capitalization. No inheritance applied. Read/write TextCapType.

---