com.aspose.slides
Class PortionFormat

java.lang.Object
  extended by com.aspose.slides.PortionFormat
All Implemented Interfaces:
IChartPortionFormat, IHyperlinkContainer, IPortionFormat

public class PortionFormat
extends java.lang.Object
implements IPortionFormat, IChartPortionFormat

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

PortionFormat

public PortionFormat(Portion parentPortion)

Initializes a new instance of the TextCharacterPropertiesEx class.


PortionFormat

public PortionFormat(PortionFormat props)

Initializes a new instance of the TextCharacterPropertiesEx class.


PortionFormat

public PortionFormat(ParagraphFormat parentParagraphFormat)

Initializes a new instance of the TextCharacterPropertiesEx class.

Method Detail

getLineFormat

public ILineFormat getLineFormat()

Returns the LineFormat properties for text outlining. No inheritance applied. Read-only LineFormat.

Specified by:
getLineFormat in interface IChartPortionFormat
Specified by:
getLineFormat in interface IPortionFormat

getFillFormat

public IFillFormat getFillFormat()

Returns the text FillFormat properties. No inheritance applied. Read-only FillFormat.

Specified by:
getFillFormat in interface IChartPortionFormat
Specified by:
getFillFormat in interface IPortionFormat

getEffectFormat

public IEffectFormat getEffectFormat()

Returns the text EffectFormat properties. No inheritance applied. Read-only EffectFormat.

Specified by:
getEffectFormat in interface IChartPortionFormat
Specified by:
getEffectFormat in interface IPortionFormat

getHighlightColor

public IColorFormat getHighlightColor()

Returns the color used to highlight a text. No inheritance applied. Read-only ColorFormat.

Specified by:
getHighlightColor in interface IChartPortionFormat
Specified by:
getHighlightColor in interface IPortionFormat

getUnderlineLineFormat

public ILineFormat getUnderlineLineFormat()

Returns the LineFormat properties used to outline underline line. No inheritance applied. Read-only LineFormat.

Specified by:
getUnderlineLineFormat in interface IChartPortionFormat
Specified by:
getUnderlineLineFormat in interface IPortionFormat

getUnderlineFillFormat

public IFillFormat getUnderlineFillFormat()

Returns the underline line FillFormat properties. No inheritance applied. Read-only FillFormat.

Specified by:
getUnderlineFillFormat in interface IChartPortionFormat
Specified by:
getUnderlineFillFormat in interface IPortionFormat

getBookmarkId

public java.lang.String getBookmarkId()

Returns or sets bookmark identifier. Read/write string.

Specified by:
getBookmarkId in interface IPortionFormat

setBookmarkId

public void setBookmarkId(java.lang.String value)
Specified by:
setBookmarkId in interface IPortionFormat

getHyperlinkClick

public IHyperlink getHyperlinkClick()

Returns or sets the hyperlink defined for mouse click. Read/write Hyperlink.

Specified by:
getHyperlinkClick in interface IHyperlinkContainer

setHyperlinkClick

public void setHyperlinkClick(IHyperlink value)
Specified by:
setHyperlinkClick in interface IHyperlinkContainer

getHLinkClick

@Deprecated
public Hyperlink getHLinkClick()
Deprecated. 

Returns or sets the hyperlink defined for mouse click. Read/write Hyperlink.


setHLinkClick

@Deprecated
public void setHLinkClick(Hyperlink value)
Deprecated. 


getHyperlinkMouseOver

public IHyperlink getHyperlinkMouseOver()

Returns or sets the hyperlink defined for mouse over. Read/write Hyperlink.

Specified by:
getHyperlinkMouseOver in interface IHyperlinkContainer

setHyperlinkMouseOver

public void setHyperlinkMouseOver(IHyperlink value)
Specified by:
setHyperlinkMouseOver in interface IHyperlinkContainer

getHLinkMouseOver

@Deprecated
public Hyperlink getHLinkMouseOver()
Deprecated. 

Returns or sets the hyperlink defined for mouse over. Read/write Hyperlink.


setHLinkMouseOver

@Deprecated
public void setHLinkMouseOver(Hyperlink value)
Deprecated. 


getHyperlinkManager

public IHyperlinkManager getHyperlinkManager()
Specified by:
getHyperlinkManager in interface IHyperlinkContainer

getFontBold

public byte getFontBold()

Determines whether the font is bold. No inheritance applied. Read/write NullableBool.

Specified by:
getFontBold in interface IChartPortionFormat
Specified by:
getFontBold in interface IPortionFormat

setFontBold

public void setFontBold(byte value)
Specified by:
setFontBold in interface IChartPortionFormat
Specified by:
setFontBold in interface IPortionFormat

getFontItalic

public byte getFontItalic()

Determines whether the font is itallic. No inheritance applied. Read/write NullableBool.

Specified by:
getFontItalic in interface IChartPortionFormat
Specified by:
getFontItalic in interface IPortionFormat

setFontItalic

public void setFontItalic(byte value)
Specified by:
setFontItalic in interface IChartPortionFormat
Specified by:
setFontItalic in interface IPortionFormat

getKumimoji

public byte getKumimoji()

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

Specified by:
getKumimoji in interface IChartPortionFormat
Specified by:
getKumimoji in interface IPortionFormat

setKumimoji

public void setKumimoji(byte value)
Specified by:
setKumimoji in interface IChartPortionFormat
Specified by:
setKumimoji in interface IPortionFormat

getNormaliseHeight

public byte getNormaliseHeight()

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

Specified by:
getNormaliseHeight in interface IChartPortionFormat
Specified by:
getNormaliseHeight in interface IPortionFormat

setNormaliseHeight

public void setNormaliseHeight(byte value)
Specified by:
setNormaliseHeight in interface IChartPortionFormat
Specified by:
setNormaliseHeight in interface IPortionFormat

getProofDisabled

public byte getProofDisabled()

Determines whether the text shouldn't be proofed. No inheritance applied. Read/write NullableBool.

Specified by:
getProofDisabled in interface IChartPortionFormat
Specified by:
getProofDisabled in interface IPortionFormat

setProofDisabled

public void setProofDisabled(byte value)
Specified by:
setProofDisabled in interface IChartPortionFormat
Specified by:
setProofDisabled in interface IPortionFormat

getFontUnderline

public int getFontUnderline()

Returns or sets the text underline type. No inheritance applied. Read/write TextUnderlineType.

Specified by:
getFontUnderline in interface IChartPortionFormat
Specified by:
getFontUnderline in interface IPortionFormat

setFontUnderline

public void setFontUnderline(int value)
Specified by:
setFontUnderline in interface IChartPortionFormat
Specified by:
setFontUnderline in interface IPortionFormat

getTextCapType

public int getTextCapType()

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

Specified by:
getTextCapType in interface IChartPortionFormat
Specified by:
getTextCapType in interface IPortionFormat

setTextCapType

public void setTextCapType(int value)
Specified by:
setTextCapType in interface IChartPortionFormat
Specified by:
setTextCapType in interface IPortionFormat

getStrikethroughType

public int getStrikethroughType()

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

Specified by:
getStrikethroughType in interface IChartPortionFormat
Specified by:
getStrikethroughType in interface IPortionFormat

setStrikethroughType

public void setStrikethroughType(int value)
Specified by:
setStrikethroughType in interface IChartPortionFormat
Specified by:
setStrikethroughType in interface IPortionFormat

getSmartTagClean

public boolean getSmartTagClean()

Determines whether the smart tag should be cleaned. No inheritance applied. Read/write bool.

Specified by:
getSmartTagClean in interface IPortionFormat

setSmartTagClean

public void setSmartTagClean(boolean value)
Specified by:
setSmartTagClean in interface IPortionFormat

isHardUnderlineLine

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.

Specified by:
isHardUnderlineLine in interface IChartPortionFormat
Specified by:
isHardUnderlineLine in interface IPortionFormat

setHardUnderlineLine

public void setHardUnderlineLine(byte value)
Specified by:
setHardUnderlineLine in interface IChartPortionFormat
Specified by:
setHardUnderlineLine in interface IPortionFormat

isHardUnderlineFill

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.

Specified by:
isHardUnderlineFill in interface IChartPortionFormat
Specified by:
isHardUnderlineFill in interface IPortionFormat

setHardUnderlineFill

public void setHardUnderlineFill(byte value)
Specified by:
setHardUnderlineFill in interface IChartPortionFormat
Specified by:
setHardUnderlineFill in interface IPortionFormat

getFontHeight

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.

Specified by:
getFontHeight in interface IChartPortionFormat
Specified by:
getFontHeight in interface IPortionFormat

setFontHeight

public void setFontHeight(float value)
Specified by:
setFontHeight in interface IChartPortionFormat
Specified by:
setFontHeight in interface IPortionFormat

getLatinFont

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.

Specified by:
getLatinFont in interface IChartPortionFormat
Specified by:
getLatinFont in interface IPortionFormat

setLatinFont

public void setLatinFont(IFontData value)
Specified by:
setLatinFont in interface IChartPortionFormat
Specified by:
setLatinFont in interface IPortionFormat

getEastAsianFont

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.

Specified by:
getEastAsianFont in interface IChartPortionFormat
Specified by:
getEastAsianFont in interface IPortionFormat

setEastAsianFont

public void setEastAsianFont(IFontData value)
Specified by:
setEastAsianFont in interface IChartPortionFormat
Specified by:
setEastAsianFont in interface IPortionFormat

getComplexScriptFont

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.

Specified by:
getComplexScriptFont in interface IChartPortionFormat
Specified by:
getComplexScriptFont in interface IPortionFormat

setComplexScriptFont

public void setComplexScriptFont(IFontData value)
Specified by:
setComplexScriptFont in interface IChartPortionFormat
Specified by:
setComplexScriptFont in interface IPortionFormat

getSymbolFont

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.

Specified by:
getSymbolFont in interface IChartPortionFormat
Specified by:
getSymbolFont in interface IPortionFormat

setSymbolFont

public void setSymbolFont(IFontData value)
Specified by:
setSymbolFont in interface IChartPortionFormat
Specified by:
setSymbolFont in interface IPortionFormat

getEscapement

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.

Specified by:
getEscapement in interface IChartPortionFormat
Specified by:
getEscapement in interface IPortionFormat

setEscapement

public void setEscapement(float value)
Specified by:
setEscapement in interface IChartPortionFormat
Specified by:
setEscapement in interface IPortionFormat

getKerningMinimalSize

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.

Specified by:
getKerningMinimalSize in interface IChartPortionFormat
Specified by:
getKerningMinimalSize in interface IPortionFormat

setKerningMinimalSize

public void setKerningMinimalSize(float value)
Specified by:
setKerningMinimalSize in interface IChartPortionFormat
Specified by:
setKerningMinimalSize in interface IPortionFormat

getLanguageId

public java.lang.String getLanguageId()

Returns or sets the Id of a language. Read/write string.

Specified by:
getLanguageId in interface IChartPortionFormat
Specified by:
getLanguageId in interface IPortionFormat

setLanguageId

public void setLanguageId(java.lang.String value)
Specified by:
setLanguageId in interface IChartPortionFormat
Specified by:
setLanguageId in interface IPortionFormat

getAlternativeLanguageId

public java.lang.String getAlternativeLanguageId()

Returns or sets the Id of an alternative language. Read/write string.

Specified by:
getAlternativeLanguageId in interface IChartPortionFormat
Specified by:
getAlternativeLanguageId in interface IPortionFormat

setAlternativeLanguageId

public void setAlternativeLanguageId(java.lang.String value)
Specified by:
setAlternativeLanguageId in interface IChartPortionFormat
Specified by:
setAlternativeLanguageId in interface IPortionFormat

getSpacing

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.

Specified by:
getSpacing in interface IChartPortionFormat
Specified by:
getSpacing in interface IPortionFormat

setSpacing

public void setSpacing(float value)
Specified by:
setSpacing in interface IChartPortionFormat
Specified by:
setSpacing in interface IPortionFormat