public abstract class BasePortionFormat extends PVIObject implements IBasePortionFormat
Common text portion formatting properties.
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.
|
equals, getParent_Immediate, getParent_IPresentationComponent, getParent_ISlideComponent, getPresentation, getSlide, getVersion, hashCode, reset_Parent_IPresentationComponent
public final ILineFormat getLineFormat()
Returns the LineFormat properties for text outlining. No inheritance applied.
Read-only ILineFormat
.
getLineFormat
in interface IBasePortionFormat
public final IFillFormat getFillFormat()
Returns the text FillFormat properties. No inheritance applied.
Read-only IFillFormat
.
getFillFormat
in interface IBasePortionFormat
public final IEffectFormat getEffectFormat()
Returns the text EffectFormat properties. No inheritance applied.
Read-only IEffectFormat
.
getEffectFormat
in interface IBasePortionFormat
public final IColorFormat getHighlightColor()
Returns the color used to highlight a text. No inheritance applied.
Read-only IColorFormat
.
getHighlightColor
in interface IBasePortionFormat
public final ILineFormat getUnderlineLineFormat()
Returns the LineFormat properties used to outline underline line. No inheritance applied.
Read-only ILineFormat
.
getUnderlineLineFormat
in interface IBasePortionFormat
public final IFillFormat getUnderlineFillFormat()
Returns the underline line FillFormat properties. No inheritance applied.
Read-only IFillFormat
.
getUnderlineFillFormat
in interface IBasePortionFormat
public final byte getFontBold()
Determines whether the font is bold. No inheritance applied.
Read/write NullableBool
.
getFontBold
in interface IBasePortionFormat
public final void setFontBold(byte value)
Determines whether the font is bold. No inheritance applied.
Read/write NullableBool
.
setFontBold
in interface IBasePortionFormat
public final byte getFontItalic()
Determines whether the font is itallic. No inheritance applied.
Read/write NullableBool
.
getFontItalic
in interface IBasePortionFormat
public final void setFontItalic(byte value)
Determines whether the font is itallic. No inheritance applied.
Read/write NullableBool
.
setFontItalic
in interface IBasePortionFormat
public final byte getKumimoji()
Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied.
Read/write NullableBool
.
getKumimoji
in interface IBasePortionFormat
public final void setKumimoji(byte value)
Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied.
Read/write NullableBool
.
setKumimoji
in interface IBasePortionFormat
public final byte getNormaliseHeight()
Determines whether the height of a text should be normalized. No inheritance applied.
Read/write NullableBool
.
getNormaliseHeight
in interface IBasePortionFormat
public final void setNormaliseHeight(byte value)
Determines whether the height of a text should be normalized. No inheritance applied.
Read/write NullableBool
.
setNormaliseHeight
in interface IBasePortionFormat
public final byte getProofDisabled()
Determines whether the text shouldn't be proofed. No inheritance applied.
Read/write NullableBool
.
getProofDisabled
in interface IBasePortionFormat
public final void setProofDisabled(byte value)
Determines whether the text shouldn't be proofed. No inheritance applied.
Read/write NullableBool
.
setProofDisabled
in interface IBasePortionFormat
public final byte getFontUnderline()
Returns or sets the text underline type. No inheritance applied.
Read/write TextUnderlineType
.
getFontUnderline
in interface IBasePortionFormat
public final void setFontUnderline(byte value)
Returns or sets the text underline type. No inheritance applied.
Read/write TextUnderlineType
.
setFontUnderline
in interface IBasePortionFormat
public final byte getTextCapType()
Returns or sets the type of text capitalization. No inheritance applied.
Read/write TextCapType
.
getTextCapType
in interface IBasePortionFormat
public final void setTextCapType(byte value)
Returns or sets the type of text capitalization. No inheritance applied.
Read/write TextCapType
.
setTextCapType
in interface IBasePortionFormat
public final byte getStrikethroughType()
Returns or sets the strikethrough type of a text. No inheritance applied.
Read/write TextStrikethroughType
.
getStrikethroughType
in interface IBasePortionFormat
public final void setStrikethroughType(byte value)
Returns or sets the strikethrough type of a text. No inheritance applied.
Read/write TextStrikethroughType
.
setStrikethroughType
in interface IBasePortionFormat
public final byte isHardUnderlineLine()
Determines whether the underline style has own LineFormat properties or inherits it
from the LineFormat properties of the text.
Read/write NullableBool
.
isHardUnderlineLine
in interface IBasePortionFormat
public final 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
.
setHardUnderlineLine
in interface IBasePortionFormat
public final byte isHardUnderlineFill()
Determines whether the underline style has own FillFormat properties or inherits it
from the FillFormat properties of the text.
Read/write NullableBool
.
isHardUnderlineFill
in interface IBasePortionFormat
public final 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
.
setHardUnderlineFill
in interface IBasePortionFormat
public final 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
.
getFontHeight
in interface IBasePortionFormat
public final 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
.
setFontHeight
in interface IBasePortionFormat
public final IFontData getLatinFont()
Returns or sets the Latin font info.
Null means font is undefined and should be inherited from the Master.
Read/write IFontData
.
getLatinFont
in interface IBasePortionFormat
public final 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
.
setLatinFont
in interface IBasePortionFormat
public final 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
.
getEastAsianFont
in interface IBasePortionFormat
public final 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
.
setEastAsianFont
in interface IBasePortionFormat
public final 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
.
getComplexScriptFont
in interface IBasePortionFormat
public final 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
.
setComplexScriptFont
in interface IBasePortionFormat
public final IFontData getSymbolFont()
Returns or sets the symbolic font info.
Null means font is undefined and should be inherited from the Master.
Read/write IFontData
.
getSymbolFont
in interface IBasePortionFormat
public final 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
.
setSymbolFont
in interface IBasePortionFormat
public final 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
.
getEscapement
in interface IBasePortionFormat
public final 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
.
setEscapement
in interface IBasePortionFormat
public final 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
.
getKerningMinimalSize
in interface IBasePortionFormat
public final 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
.
setKerningMinimalSize
in interface IBasePortionFormat
public final java.lang.String getLanguageId()
Returns or sets the Id of a proofing language. Used for checking spelling and grammar.
Read/write String
.
getLanguageId
in interface IBasePortionFormat
public final void setLanguageId(java.lang.String value)
Returns or sets the Id of a proofing language. Used for checking spelling and grammar.
Read/write String
.
setLanguageId
in interface IBasePortionFormat
public final java.lang.String getAlternativeLanguageId()
Returns or sets the Id of an alternative language.
Read/write String
.
getAlternativeLanguageId
in interface IBasePortionFormat
public final void setAlternativeLanguageId(java.lang.String value)
Returns or sets the Id of an alternative language.
Read/write String
.
setAlternativeLanguageId
in interface IBasePortionFormat
public final 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
.
getSpacing
in interface IBasePortionFormat
public final 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
.
setSpacing
in interface IBasePortionFormat