public interface IBasePortionFormat
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 IPortionFormat.getEffective()
method
which returns a IPortionFormatEffectiveData
instance.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAlternativeLanguageId()
Returns or sets the Id of an alternative language.
|
IFontData |
getComplexScriptFont()
Returns or sets the complex script font info.
|
IFontData |
getEastAsianFont()
Returns or sets the East Asian font info.
|
IEffectFormat |
getEffectFormat()
Returns the text EffectFormat properties.
|
float |
getEscapement()
Returns or sets the superscript or subscript text.
|
IFillFormat |
getFillFormat()
Returns the text FillFormat properties.
|
byte |
getFontBold()
Determines whether the font is bold.
|
float |
getFontHeight()
Returns or sets the font height of a portion.
|
byte |
getFontItalic()
Determines whether the font is itallic.
|
byte |
getFontUnderline()
Returns or sets the text underline type.
|
IColorFormat |
getHighlightColor()
Returns the color used to highlight a text.
|
float |
getKerningMinimalSize()
Returns or sets the minimal font size, for which kerning should be switched on.
|
byte |
getKumimoji()
Determines whether the numbers should ignore text eastern language-specific vertical text layout.
|
java.lang.String |
getLanguageId()
Returns or sets the Id of a proofing language.
|
IFontData |
getLatinFont()
Returns or sets the Latin font info.
|
ILineFormat |
getLineFormat()
Returns the LineFormat properties for text outlining.
|
byte |
getNormaliseHeight()
Determines whether the height of a text should be normalized.
|
byte |
getProofDisabled()
Determines whether the text shouldn't be proofed.
|
float |
getSpacing()
Returns or sets the intercharacter spacing increment.
|
byte |
getStrikethroughType()
Returns or sets the strikethrough type of a text.
|
IFontData |
getSymbolFont()
Returns or sets the symbolic font info.
|
byte |
getTextCapType()
Returns or sets the type of text capitalization.
|
IFillFormat |
getUnderlineFillFormat()
Returns the underline line FillFormat properties.
|
ILineFormat |
getUnderlineLineFormat()
Returns the LineFormat properties used to outline underline line.
|
byte |
isHardUnderlineFill()
Determines whether the underline style has own FillFormat properties or inherits it
from the FillFormat properties of the text.
|
byte |
isHardUnderlineLine()
Determines whether the underline style has own LineFormat properties or inherits it
from the LineFormat properties of the text.
|
void |
setAlternativeLanguageId(java.lang.String value)
Returns or sets the Id of an alternative language.
|
void |
setComplexScriptFont(IFontData value)
Returns or sets the complex script font info.
|
void |
setEastAsianFont(IFontData value)
Returns or sets the East Asian font info.
|
void |
setEscapement(float value)
Returns or sets the superscript or subscript text.
|
void |
setFontBold(byte value)
Determines whether the font is bold.
|
void |
setFontHeight(float value)
Returns or sets the font height of a portion.
|
void |
setFontItalic(byte value)
Determines whether the font is itallic.
|
void |
setFontUnderline(byte value)
Returns or sets the text underline type.
|
void |
setHardUnderlineFill(byte value)
Determines whether the underline style has own FillFormat properties or inherits it
from the FillFormat properties of the text.
|
void |
setHardUnderlineLine(byte value)
Determines whether the underline style has own LineFormat properties or inherits it
from the LineFormat properties of the text.
|
void |
setKerningMinimalSize(float value)
Returns or sets the minimal font size, for which kerning should be switched on.
|
void |
setKumimoji(byte value)
Determines whether the numbers should ignore text eastern language-specific vertical text layout.
|
void |
setLanguageId(java.lang.String value)
Returns or sets the Id of a proofing language.
|
void |
setLatinFont(IFontData value)
Returns or sets the Latin font info.
|
void |
setNormaliseHeight(byte value)
Determines whether the height of a text should be normalized.
|
void |
setProofDisabled(byte value)
Determines whether the text shouldn't be proofed.
|
void |
setSpacing(float value)
Returns or sets the intercharacter spacing increment.
|
void |
setStrikethroughType(byte value)
Returns or sets the strikethrough type of a text.
|
void |
setSymbolFont(IFontData value)
Returns or sets the symbolic font info.
|
void |
setTextCapType(byte value)
Returns or sets the type of text capitalization.
|
ILineFormat getLineFormat()
Returns the LineFormat properties for text outlining. No inheritance applied.
Read-only ILineFormat
.
IFillFormat getFillFormat()
Returns the text FillFormat properties. No inheritance applied.
Read-only IFillFormat
.
IEffectFormat getEffectFormat()
Returns the text EffectFormat properties. No inheritance applied.
Read-only IEffectFormat
.
IColorFormat getHighlightColor()
Returns the color used to highlight a text. No inheritance applied.
Read-only IColorFormat
.
ILineFormat getUnderlineLineFormat()
Returns the LineFormat properties used to outline underline line. No inheritance applied.
Read-only ILineFormat
.
IFillFormat getUnderlineFillFormat()
Returns the underline line FillFormat properties. No inheritance applied.
Read-only IFillFormat
.
byte getFontBold()
Determines whether the font is bold. No inheritance applied.
Read/write NullableBool
.
void setFontBold(byte value)
Determines whether the font is bold. No inheritance applied.
Read/write NullableBool
.
byte getFontItalic()
Determines whether the font is itallic. No inheritance applied.
Read/write NullableBool
.
void setFontItalic(byte value)
Determines whether the font is itallic. No inheritance applied.
Read/write NullableBool
.
byte getKumimoji()
Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied.
Read/write NullableBool
.
void setKumimoji(byte value)
Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied.
Read/write NullableBool
.
byte getNormaliseHeight()
Determines whether the height of a text should be normalized. No inheritance applied.
Read/write NullableBool
.
void setNormaliseHeight(byte value)
Determines whether the height of a text should be normalized. No inheritance applied.
Read/write NullableBool
.
byte getProofDisabled()
Determines whether the text shouldn't be proofed. No inheritance applied.
Read/write NullableBool
.
void setProofDisabled(byte value)
Determines whether the text shouldn't be proofed. No inheritance applied.
Read/write NullableBool
.
byte getFontUnderline()
Returns or sets the text underline type. No inheritance applied.
Read/write TextUnderlineType
.
void setFontUnderline(byte value)
Returns or sets the text underline type. No inheritance applied.
Read/write TextUnderlineType
.
byte getTextCapType()
Returns or sets the type of text capitalization. No inheritance applied.
Read/write TextCapType
.
void setTextCapType(byte value)
Returns or sets the type of text capitalization. No inheritance applied.
Read/write TextCapType
.
byte getStrikethroughType()
Returns or sets the strikethrough type of a text. No inheritance applied.
Read/write TextStrikethroughType
.
void setStrikethroughType(byte value)
Returns or sets the strikethrough type of a text. No inheritance applied.
Read/write TextStrikethroughType
.
byte isHardUnderlineLine()
Determines whether the underline style has own LineFormat properties or inherits it
from the LineFormat properties of the text.
Read/write NullableBool
.
void setHardUnderlineLine(byte value)
Determines whether the underline style has own LineFormat properties or inherits it
from the LineFormat properties of the text.
Read/write NullableBool
.
byte isHardUnderlineFill()
Determines whether the underline style has own FillFormat properties or inherits it
from the FillFormat properties of the text.
Read/write NullableBool
.
void setHardUnderlineFill(byte value)
Determines whether the underline style has own FillFormat properties or inherits it
from the FillFormat properties of the text.
Read/write NullableBool
.
float 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
.
void setFontHeight(float value)
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
.
IFontData getLatinFont()
Returns or sets the Latin font info.
Null means font is undefined and should be inherited from the Master.
Read/write IFontData
.
void setLatinFont(IFontData value)
Returns or sets the Latin font info.
Null means font is undefined and should be inherited from the Master.
Read/write IFontData
.
IFontData getEastAsianFont()
Returns or sets the East Asian font info.
Null means font is undefined and should be inherited from the Master.
Read/write IFontData
.
void setEastAsianFont(IFontData value)
Returns or sets the East Asian font info.
Null means font is undefined and should be inherited from the Master.
Read/write IFontData
.
IFontData getComplexScriptFont()
Returns or sets the complex script font info.
Null means font is undefined and should be inherited from the Master.
Read/write IFontData
.
void setComplexScriptFont(IFontData value)
Returns or sets the complex script font info.
Null means font is undefined and should be inherited from the Master.
Read/write IFontData
.
IFontData getSymbolFont()
Returns or sets the symbolic font info.
Null means font is undefined and should be inherited from the Master.
Read/write IFontData
.
void setSymbolFont(IFontData value)
Returns or sets the symbolic font info.
Null means font is undefined and should be inherited from the Master.
Read/write IFontData
.
float 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
.
void setEscapement(float value)
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
.
float 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
.
void setKerningMinimalSize(float value)
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
.
java.lang.String getLanguageId()
Returns or sets the Id of a proofing language. Used for checking spelling and grammar.
Read/write String
.
void setLanguageId(java.lang.String value)
Returns or sets the Id of a proofing language. Used for checking spelling and grammar.
Read/write String
.
java.lang.String getAlternativeLanguageId()
Returns or sets the Id of an alternative language.
Read/write String
.
void setAlternativeLanguageId(java.lang.String value)
Returns or sets the Id of an alternative language.
Read/write String
.
float getSpacing()
Returns or sets the intercharacter spacing increment.
Float.NaN means value is undefined and should be inherited from the Master.
Read/write float
.
void setSpacing(float value)
Returns or sets the intercharacter spacing increment.
Float.NaN means value is undefined and should be inherited from the Master.
Read/write float
.