|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.slides.PortionFormat
public class PortionFormat
This class contains the text portion formatting properties. Unlike PortionFormatEffectiveData
, 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 PortionEx.CreatePortionFormatEffective
method
which returns a CreatePortionFormatEffective
instance.
Constructor Summary | |
---|---|
PortionFormat(ParagraphFormat parentParagraphFormat)
Initializes a new instance of the TextCharacterPropertiesEx class. |
|
PortionFormat(Portion parentPortion)
Initializes a new instance of the TextCharacterPropertiesEx class. |
|
PortionFormat(PortionFormat props)
Initializes a new instance of the TextCharacterPropertiesEx class. |
Method Summary | |
---|---|
java.lang.String |
getAlternativeLanguageId()
Returns or sets the Id of an alternative language. |
java.lang.String |
getBookmarkId()
Returns or sets bookmark identifier. |
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. |
int |
getFontUnderline()
Returns or sets the text underline type. |
IColorFormat |
getHighlightColor()
Returns the color used to highlight a text. |
Hyperlink |
getHLinkClick()
Deprecated. |
Hyperlink |
getHLinkMouseOver()
Deprecated. |
IHyperlink |
getHyperlinkClick()
Returns or sets the hyperlink defined for mouse click. |
IHyperlinkManager |
getHyperlinkManager()
|
IHyperlink |
getHyperlinkMouseOver()
Returns or sets the hyperlink defined for mouse over. |
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 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. |
boolean |
getSmartTagClean()
Determines whether the smart tag should be cleaned. |
float |
getSpacing()
Returns or sets the intercharacter spacing increment. |
int |
getStrikethroughType()
Returns or sets the strikethrough type of a text. |
IFontData |
getSymbolFont()
Returns or sets the symbolic font info. |
int |
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)
|
void |
setBookmarkId(java.lang.String value)
|
void |
setComplexScriptFont(IFontData value)
|
void |
setEastAsianFont(IFontData value)
|
void |
setEscapement(float value)
|
void |
setFontBold(byte value)
|
void |
setFontHeight(float value)
|
void |
setFontItalic(byte value)
|
void |
setFontUnderline(int value)
|
void |
setHardUnderlineFill(byte value)
|
void |
setHardUnderlineLine(byte value)
|
void |
setHLinkClick(Hyperlink value)
Deprecated. |
void |
setHLinkMouseOver(Hyperlink value)
Deprecated. |
void |
setHyperlinkClick(IHyperlink value)
|
void |
setHyperlinkMouseOver(IHyperlink value)
|
void |
setKerningMinimalSize(float value)
|
void |
setKumimoji(byte value)
|
void |
setLanguageId(java.lang.String value)
|
void |
setLatinFont(IFontData value)
|
void |
setNormaliseHeight(byte value)
|
void |
setProofDisabled(byte value)
|
void |
setSmartTagClean(boolean value)
|
void |
setSpacing(float value)
|
void |
setStrikethroughType(int value)
|
void |
setSymbolFont(IFontData value)
|
void |
setTextCapType(int value)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PortionFormat(Portion parentPortion)
Initializes a new instance of the TextCharacterPropertiesEx class.
public PortionFormat(PortionFormat props)
Initializes a new instance of the TextCharacterPropertiesEx class.
public PortionFormat(ParagraphFormat parentParagraphFormat)
Initializes a new instance of the TextCharacterPropertiesEx class.
Method Detail |
---|
public ILineFormat getLineFormat()
Returns the LineFormat properties for text outlining. No inheritance applied.
Read-only LineFormat
.
getLineFormat
in interface IChartPortionFormat
getLineFormat
in interface IPortionFormat
public IFillFormat getFillFormat()
Returns the text FillFormat properties. No inheritance applied.
Read-only FillFormat
.
getFillFormat
in interface IChartPortionFormat
getFillFormat
in interface IPortionFormat
public IEffectFormat getEffectFormat()
Returns the text EffectFormat properties. No inheritance applied.
Read-only EffectFormat
.
getEffectFormat
in interface IChartPortionFormat
getEffectFormat
in interface IPortionFormat
public IColorFormat getHighlightColor()
Returns the color used to highlight a text. No inheritance applied.
Read-only ColorFormat
.
getHighlightColor
in interface IChartPortionFormat
getHighlightColor
in interface IPortionFormat
public ILineFormat getUnderlineLineFormat()
Returns the LineFormat properties used to outline underline line. No inheritance applied.
Read-only LineFormat
.
getUnderlineLineFormat
in interface IChartPortionFormat
getUnderlineLineFormat
in interface IPortionFormat
public IFillFormat getUnderlineFillFormat()
Returns the underline line FillFormat properties. No inheritance applied.
Read-only FillFormat
.
getUnderlineFillFormat
in interface IChartPortionFormat
getUnderlineFillFormat
in interface IPortionFormat
public java.lang.String getBookmarkId()
Returns or sets bookmark identifier.
Read/write string
.
getBookmarkId
in interface IPortionFormat
public void setBookmarkId(java.lang.String value)
setBookmarkId
in interface IPortionFormat
public IHyperlink getHyperlinkClick()
Returns or sets the hyperlink defined for mouse click.
Read/write Hyperlink
.
getHyperlinkClick
in interface IHyperlinkContainer
public void setHyperlinkClick(IHyperlink value)
setHyperlinkClick
in interface IHyperlinkContainer
@Deprecated public Hyperlink getHLinkClick()
Returns or sets the hyperlink defined for mouse click.
Read/write Hyperlink
.
@Deprecated public void setHLinkClick(Hyperlink value)
public IHyperlink getHyperlinkMouseOver()
Returns or sets the hyperlink defined for mouse over.
Read/write Hyperlink
.
getHyperlinkMouseOver
in interface IHyperlinkContainer
public void setHyperlinkMouseOver(IHyperlink value)
setHyperlinkMouseOver
in interface IHyperlinkContainer
@Deprecated public Hyperlink getHLinkMouseOver()
Returns or sets the hyperlink defined for mouse over.
Read/write Hyperlink
.
@Deprecated public void setHLinkMouseOver(Hyperlink value)
public IHyperlinkManager getHyperlinkManager()
getHyperlinkManager
in interface IHyperlinkContainer
public byte getFontBold()
Determines whether the font is bold. No inheritance applied.
Read/write NullableBool
.
getFontBold
in interface IChartPortionFormat
getFontBold
in interface IPortionFormat
public void setFontBold(byte value)
setFontBold
in interface IChartPortionFormat
setFontBold
in interface IPortionFormat
public byte getFontItalic()
Determines whether the font is itallic. No inheritance applied.
Read/write NullableBool
.
getFontItalic
in interface IChartPortionFormat
getFontItalic
in interface IPortionFormat
public void setFontItalic(byte value)
setFontItalic
in interface IChartPortionFormat
setFontItalic
in interface IPortionFormat
public byte getKumimoji()
Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied.
Read/write NullableBool
.
getKumimoji
in interface IChartPortionFormat
getKumimoji
in interface IPortionFormat
public void setKumimoji(byte value)
setKumimoji
in interface IChartPortionFormat
setKumimoji
in interface IPortionFormat
public byte getNormaliseHeight()
Determines whether the height of a text should be normalized. No inheritance applied.
Read/write NullableBool
.
getNormaliseHeight
in interface IChartPortionFormat
getNormaliseHeight
in interface IPortionFormat
public void setNormaliseHeight(byte value)
setNormaliseHeight
in interface IChartPortionFormat
setNormaliseHeight
in interface IPortionFormat
public byte getProofDisabled()
Determines whether the text shouldn't be proofed. No inheritance applied.
Read/write NullableBool
.
getProofDisabled
in interface IChartPortionFormat
getProofDisabled
in interface IPortionFormat
public void setProofDisabled(byte value)
setProofDisabled
in interface IChartPortionFormat
setProofDisabled
in interface IPortionFormat
public int getFontUnderline()
Returns or sets the text underline type. No inheritance applied.
Read/write TextUnderlineType
.
getFontUnderline
in interface IChartPortionFormat
getFontUnderline
in interface IPortionFormat
public void setFontUnderline(int value)
setFontUnderline
in interface IChartPortionFormat
setFontUnderline
in interface IPortionFormat
public int getTextCapType()
Returns or sets the type of text capitalization. No inheritance applied.
Read/write TextCapType
.
getTextCapType
in interface IChartPortionFormat
getTextCapType
in interface IPortionFormat
public void setTextCapType(int value)
setTextCapType
in interface IChartPortionFormat
setTextCapType
in interface IPortionFormat
public int getStrikethroughType()
Returns or sets the strikethrough type of a text. No inheritance applied.
Read/write TextStrikethroughType
.
getStrikethroughType
in interface IChartPortionFormat
getStrikethroughType
in interface IPortionFormat
public void setStrikethroughType(int value)
setStrikethroughType
in interface IChartPortionFormat
setStrikethroughType
in interface IPortionFormat
public boolean getSmartTagClean()
Determines whether the smart tag should be cleaned. No inheritance applied.
Read/write bool
.
getSmartTagClean
in interface IPortionFormat
public void setSmartTagClean(boolean value)
setSmartTagClean
in interface IPortionFormat
public 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 IChartPortionFormat
isHardUnderlineLine
in interface IPortionFormat
public void setHardUnderlineLine(byte value)
setHardUnderlineLine
in interface IChartPortionFormat
setHardUnderlineLine
in interface IPortionFormat
public 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 IChartPortionFormat
isHardUnderlineFill
in interface IPortionFormat
public void setHardUnderlineFill(byte value)
setHardUnderlineFill
in interface IChartPortionFormat
setHardUnderlineFill
in interface IPortionFormat
public float getFontHeight()
Returns or sets the font height of a portion.
<b>float.NaN</b>
means height is undefined and should be inherited from the Master.
Read/write short
.
getFontHeight
in interface IChartPortionFormat
getFontHeight
in interface IPortionFormat
public void setFontHeight(float value)
setFontHeight
in interface IChartPortionFormat
setFontHeight
in interface IPortionFormat
public IFontData getLatinFont()
Returns or sets the Latin font info.
Null means font is undefined and should be inherited from the Master.
Read/write FontData
.
getLatinFont
in interface IChartPortionFormat
getLatinFont
in interface IPortionFormat
public void setLatinFont(IFontData value)
setLatinFont
in interface IChartPortionFormat
setLatinFont
in interface IPortionFormat
public IFontData getEastAsianFont()
Returns or sets the East Asian font info.
Null means font is undefined and should be inherited from the Master.
Read/write FontData
.
getEastAsianFont
in interface IChartPortionFormat
getEastAsianFont
in interface IPortionFormat
public void setEastAsianFont(IFontData value)
setEastAsianFont
in interface IChartPortionFormat
setEastAsianFont
in interface IPortionFormat
public IFontData getComplexScriptFont()
Returns or sets the complex script font info.
Null means font is undefined and should be inherited from the Master.
Read/write FontData
.
getComplexScriptFont
in interface IChartPortionFormat
getComplexScriptFont
in interface IPortionFormat
public void setComplexScriptFont(IFontData value)
setComplexScriptFont
in interface IChartPortionFormat
setComplexScriptFont
in interface IPortionFormat
public IFontData getSymbolFont()
Returns or sets the symbolic font info.
Null means font is undefined and should be inherited from the Master.
Read/write FontData
.
getSymbolFont
in interface IChartPortionFormat
getSymbolFont
in interface IPortionFormat
public void setSymbolFont(IFontData value)
setSymbolFont
in interface IChartPortionFormat
setSymbolFont
in interface IPortionFormat
public float getEscapement()
Returns or sets the superscript or subscript text.
Value from -100% (subscript) to 100% (superscript).
<b>float.NaN</b>
means value is undefined and should be inherited from the Master.
Read/write short
.
getEscapement
in interface IChartPortionFormat
getEscapement
in interface IPortionFormat
public void setEscapement(float value)
setEscapement
in interface IChartPortionFormat
setEscapement
in interface IPortionFormat
public float getKerningMinimalSize()
Returns or sets the minimal font size, for which kerning should be switched on.
<b>float.NaN</b>
means value is undefined and should be inherited from the Master.
Read/write float
.
getKerningMinimalSize
in interface IChartPortionFormat
getKerningMinimalSize
in interface IPortionFormat
public void setKerningMinimalSize(float value)
setKerningMinimalSize
in interface IChartPortionFormat
setKerningMinimalSize
in interface IPortionFormat
public java.lang.String getLanguageId()
Returns or sets the Id of a language.
Read/write string
.
getLanguageId
in interface IChartPortionFormat
getLanguageId
in interface IPortionFormat
public void setLanguageId(java.lang.String value)
setLanguageId
in interface IChartPortionFormat
setLanguageId
in interface IPortionFormat
public java.lang.String getAlternativeLanguageId()
Returns or sets the Id of an alternative language.
Read/write string
.
getAlternativeLanguageId
in interface IChartPortionFormat
getAlternativeLanguageId
in interface IPortionFormat
public void setAlternativeLanguageId(java.lang.String value)
setAlternativeLanguageId
in interface IChartPortionFormat
setAlternativeLanguageId
in interface IPortionFormat
public float getSpacing()
Returns or sets the intercharacter spacing increment.
<b>float.NaN</b>
means value is undefined and should be inherited from the Master.
Read/write float
.
getSpacing
in interface IChartPortionFormat
getSpacing
in interface IPortionFormat
public void setSpacing(float value)
setSpacing
in interface IChartPortionFormat
setSpacing
in interface IPortionFormat
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |