BasePortionFormat

BasePortionFormat class

Common text portion formatting properties.

getAlternativeLanguageId

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

Returns: String


getComplexScriptFont

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

Returns: FontData


getEastAsianFont

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

Returns: FontData


getEffectFormat

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

Returns: EffectFormat


getEscapement

NameDescription
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.

Returns: float


getFillFormat

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

Returns: FillFormat


getFontBold

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

Returns: byte


getFontHeight

NameDescription
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.

Returns: float


getFontItalic

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

Returns: byte


getFontUnderline

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

Returns: byte


getHighlightColor

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

Returns: ColorFormat


getKerningMinimalSize

NameDescription
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.

Returns: float


getKumimoji

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

Returns: byte


getLanguageId

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

Returns: String


getLatinFont

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

Returns: FontData


getLineFormat

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

Returns: LineFormat


getNormaliseHeight

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

Returns: byte


getProofDisabled

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

Returns: byte


getSpacing

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

Returns: float


getStrikethroughType

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

Returns: byte


getSymbolFont

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

Returns: FontData


getTextCapType

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

Returns: byte


getUnderlineFillFormat

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

Returns: FillFormat


getUnderlineLineFormat

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

Returns: LineFormat


getVersion

NameDescription
getVersion ()

Returns: long


isHardUnderlineFill

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

Returns: byte


isHardUnderlineLine

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

Returns: byte


setAlternativeLanguageId

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

Returns: void


setComplexScriptFont

NameDescription
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.

Returns: void


setEastAsianFont

NameDescription
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.

Returns: void


setEscapement

NameDescription
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.

Returns: void


setFontBold

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

Returns: void


setFontHeight

NameDescription
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.

Returns: void


setFontItalic

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

Returns: void


setFontUnderline

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

Returns: void


setHardUnderlineFill

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

Returns: void


setHardUnderlineLine

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

Returns: void


setKerningMinimalSize

NameDescription
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.

Returns: void


setKumimoji

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

Returns: void


setLanguageId

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

Returns: void


setLatinFont

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

Returns: void


setNormaliseHeight

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

Returns: void


setProofDisabled

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

Returns: void


setSpacing

NameDescription
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.

Returns: void


setStrikethroughType

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

Returns: void


setSymbolFont

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

Returns: void


setTextCapType

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

Returns: void