com.aspose.slides.pptx
Class TextCharacterPropertiesEx

java.lang.Object
  extended by com.aspose.slides.pptx.TextCharacterPropertiesEx
Direct Known Subclasses:
PortionEx

public class TextCharacterPropertiesEx
extends java.lang.Object

Represents a text portion with formatting.


Constructor Summary
TextCharacterPropertiesEx()
          Initializes a new instance of the TextCharacterPropertiesEx class.
TextCharacterPropertiesEx(TextCharacterPropertiesEx props)
          Initializes a new instance of the TextCharacterPropertiesEx class.
 
Method Summary
 java.lang.String getBookmarkId()
          Returns bookmark identifier.
 FillFormatEx getFillFormat()
          Returns the text FillFormatEx properties.
 ColorFormatEx getHighlightColor()
          Returns the color used to highlight a text.
 HyperlinkEx getHLinkClick()
          Returns the hyperlink defined for mouse click.
 HyperlinkEx getHLinkMouseOver()
          Returns the hyperlink defined for mouse over.
 LineFormatEx getLineFormat()
          Returns the LineFormatEx properties for text outlining.
 PresentationEx getPresentation()
          Returns the parent presentation of a text.
 java.lang.String getRawAlternativeLanguageId()
          Returns the Id of an alternative language.
 FontDataEx getRawComplexScriptFont()
          Returns or sets the complex script font info.
 FontDataEx getRawEasternAsianFont()
          Returns the eastern Asian font info.
 float getRawEscapement()
          Returns the superscript or subscript text.
 NullableBool getRawFontBold()
          Determines whether the master's font Bold property should be inverted.
 float getRawFontHeight()
          Returns the font height of a portion.
 NullableBool getRawFontItalic()
          Determines whether the master's font Italic property should be inverted.
 TextUnderlineTypeEx getRawFontUnderline()
          Returns the text underline type.
 NullableBool getRawIsHardUnderlineFill()
          Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text.
 NullableBool getRawIsHardUnderlineLine()
          Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text.
 float getRawKerningMinimalSize()
          Returns the minimal font size, for which kerning should be switched on.
 NullableBool getRawKumimoji()
          Determines whether the numbers should ignore text eastern language-specific vertical text layout.
 java.lang.String getRawLanguageId()
          Returns the Id of a language.
 FontDataEx getRawLatinFont()
          Returns the Latin font info.
 NullableBool getRawNoProof()
          Determines whether the text shouldn't be proofed.
 NullableBool getRawNormaliseHeight()
          Determines whether the height of a text should be normalized.
 float getRawSpacing()
          Returns the spacing increment between characters.
 TextStrikethroughTypeEx getRawStrikethroughType()
          Returns the strikethrough type of a text.
 FontDataEx getRawSymbolFont()
          Returns the symbolic font info.
 TextCapTypeEx getRawTextCapType()
          Returns the type of text capitalization.
 BaseSlideEx getSlide()
          Returns the parent slide of a text.
 boolean getSmartTagClean()
          Determines whether a smart tag should be cleaned.
 FillFormatEx getUnderlineFillFormat()
          Returns the underline line FillFormatEx properties.
 LineFormatEx getUnderlineLineFormat()
          Returns the LineFormatEx properties used to outline underline line.
 void setBookmarkId(java.lang.String value)
          Sets bookmark identifier.
 void setHLinkClick(HyperlinkEx value)
          Sets the hyperlink defined for mouse click.
 void setHLinkMouseOver(HyperlinkEx value)
          Sets the hyperlink defined for mouse over.
 void setRawAlternativeLanguageId(java.lang.String value)
          Sets the Id of an alternative language.
 void setRawComplexScriptFont(FontDataEx value)
          Returns or sets the complex script font info.
 void setRawEasternAsianFont(FontDataEx value)
          Sets the eastern Asian font info.
 void setRawEscapement(float value)
          Sets the superscript or subscript text.
 void setRawFontBold(NullableBool value)
          Sets whether the master's font Bold property should be inverted.
 void setRawFontHeight(float value)
          Sets the font height of a portion.
 void setRawFontItalic(NullableBool value)
          Sets whether the master's font Italic property should be inverted.
 void setRawFontUnderline(TextUnderlineTypeEx value)
          Sets the text underline type.
 void setRawIsHardUnderlineFill(NullableBool value)
          Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text.
 void setRawIsHardUnderlineLine(NullableBool value)
          Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text.
 void setRawKerningMinimalSize(float value)
          Sets the minimal font size, for which kerning should be switched on.
 void setRawKumimoji(NullableBool value)
          Determines whether the numbers should ignore text eastern language-specific vertical text layout.
 void setRawLanguageId(java.lang.String value)
          Sets the Id of a language.
 void setRawLatinFont(FontDataEx value)
          Sets the Latin font info.
 void setRawNoProof(NullableBool value)
          Determines whether the text shouldn't be proofed.
 void setRawNormaliseHeight(NullableBool value)
          Determines whether the height of a text should be normalized.
 void setRawSpacing(float value)
          Sets the spacing increment between characters.
 void setRawStrikethroughType(TextStrikethroughTypeEx value)
          Sets the strikethrough type of a text.
 void setRawSymbolFont(FontDataEx value)
          Sets the symbolic font info.
 void setRawTextCapType(TextCapTypeEx value)
          Sets the type of text capitalization.
 void setSmartTagClean(boolean value)
          Determines whether the smart tag should be cleaned.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TextCharacterPropertiesEx

public TextCharacterPropertiesEx()
Initializes a new instance of the TextCharacterPropertiesEx class.


TextCharacterPropertiesEx

public TextCharacterPropertiesEx(TextCharacterPropertiesEx props)
Initializes a new instance of the TextCharacterPropertiesEx class.

Parameters:
props - TextCharacterPropertiesEx object to clone.
Method Detail

getLineFormat

public LineFormatEx getLineFormat()
Returns the LineFormatEx properties for text outlining.

Returns:
See LineFormatEx.

getFillFormat

public FillFormatEx getFillFormat()
Returns the text FillFormatEx properties.

Returns:
See FillFormatEx.

getHighlightColor

public ColorFormatEx getHighlightColor()
Returns the color used to highlight a text.

Returns:
See ColorFormatEx.

getUnderlineLineFormat

public LineFormatEx getUnderlineLineFormat()
Returns the LineFormatEx properties used to outline underline line.

Returns:
See LineFormatEx.

getUnderlineFillFormat

public FillFormatEx getUnderlineFillFormat()
Returns the underline line FillFormatEx properties.

Returns:
See FillFormatEx.

getBookmarkId

public java.lang.String getBookmarkId()
Returns bookmark identifier.


setBookmarkId

public void setBookmarkId(java.lang.String value)
Sets bookmark identifier.

Parameters:
value - new bookmark identifier.

getHLinkClick

public HyperlinkEx getHLinkClick()
Returns the hyperlink defined for mouse click.

Returns:
See HyperlinkEx.

setHLinkClick

public void setHLinkClick(HyperlinkEx value)
Sets the hyperlink defined for mouse click.

Parameters:
value - See HyperlinkEx.

getHLinkMouseOver

public HyperlinkEx getHLinkMouseOver()
Returns the hyperlink defined for mouse over.

Returns:
See HyperlinkEx.

setHLinkMouseOver

public void setHLinkMouseOver(HyperlinkEx value)
Sets the hyperlink defined for mouse over.

Parameters:
value - See HyperlinkEx.

getRawFontBold

public NullableBool getRawFontBold()
Determines whether the master's font Bold property should be inverted.


setRawFontBold

public void setRawFontBold(NullableBool value)
Sets whether the master's font Bold property should be inverted.

Parameters:
value -

getRawFontItalic

public NullableBool getRawFontItalic()
Determines whether the master's font Italic property should be inverted.


setRawFontItalic

public void setRawFontItalic(NullableBool value)
Sets whether the master's font Italic property should be inverted.

Parameters:
value -

getRawKumimoji

public NullableBool getRawKumimoji()
Determines whether the numbers should ignore text eastern language-specific vertical text layout.


setRawKumimoji

public void setRawKumimoji(NullableBool value)
Determines whether the numbers should ignore text eastern language-specific vertical text layout.

Parameters:
value -

getRawNormaliseHeight

public NullableBool getRawNormaliseHeight()
Determines whether the height of a text should be normalized.

Returns:
NullableBool

setRawNormaliseHeight

public void setRawNormaliseHeight(NullableBool value)
Determines whether the height of a text should be normalized.

Parameters:
value -

getRawNoProof

public NullableBool getRawNoProof()
Determines whether the text shouldn't be proofed.

Returns:
NullableBool

setRawNoProof

public void setRawNoProof(NullableBool value)
Determines whether the text shouldn't be proofed.

Parameters:
value -

getRawFontUnderline

public TextUnderlineTypeEx getRawFontUnderline()
Returns the text underline type.

Returns:
TextUnderlineTypeEx

setRawFontUnderline

public void setRawFontUnderline(TextUnderlineTypeEx value)
Sets the text underline type.

Parameters:
value -

getRawTextCapType

public TextCapTypeEx getRawTextCapType()
Returns the type of text capitalization.

Returns:
TextCapTypeEx

setRawTextCapType

public void setRawTextCapType(TextCapTypeEx value)
Sets the type of text capitalization.

Parameters:
value -

getRawStrikethroughType

public TextStrikethroughTypeEx getRawStrikethroughType()
Returns the strikethrough type of a text.

Returns:
TextStrikethroughTypeEx

setRawStrikethroughType

public void setRawStrikethroughType(TextStrikethroughTypeEx value)
Sets the strikethrough type of a text.

Parameters:
value -

getSmartTagClean

public boolean getSmartTagClean()
Determines whether a smart tag should be cleaned.

Returns:
True if a smart tag should be cleaned.

setSmartTagClean

public void setSmartTagClean(boolean value)
Determines whether the smart tag should be cleaned.

Parameters:
value -

getRawIsHardUnderlineLine

public NullableBool getRawIsHardUnderlineLine()
Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text.

Returns:
NullableBool

setRawIsHardUnderlineLine

public void setRawIsHardUnderlineLine(NullableBool value)
Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text.

Parameters:
value -

getRawIsHardUnderlineFill

public NullableBool getRawIsHardUnderlineFill()
Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text.

Returns:
NullableBool

setRawIsHardUnderlineFill

public void setRawIsHardUnderlineFill(NullableBool value)
Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text.

Parameters:
value -

getRawFontHeight

public float getRawFontHeight()
Returns the font height of a portion. -1 means height is undefined and should be inherited from the Master.

Returns:
The font height of a portion.

setRawFontHeight

public void setRawFontHeight(float value)
Sets the font height of a portion. -1 means height is undefined and should be inherited from the Master.

Parameters:
value -

getRawLatinFont

public FontDataEx getRawLatinFont()
Returns the Latin font info. Null means font is undefined and should be inherited from the Master.

Returns:
FontDataEx

setRawLatinFont

public void setRawLatinFont(FontDataEx value)
Sets the Latin font info. Null means font is undefined and should be inherited from the Master.

Parameters:
value -

getRawEasternAsianFont

public FontDataEx getRawEasternAsianFont()
Returns the eastern Asian font info. Null means font is undefined and should be inherited from the Master.

Returns:
FontDataEx

setRawEasternAsianFont

public void setRawEasternAsianFont(FontDataEx value)
Sets the eastern Asian font info. Null means font is undefined and should be inherited from the Master.

Parameters:
value -

getRawComplexScriptFont

public FontDataEx getRawComplexScriptFont()
Returns or sets the complex script font info. Null means font is undefined and should be inherited from the Master.

Returns:
FontDataEx

setRawComplexScriptFont

public void setRawComplexScriptFont(FontDataEx value)
Returns or sets the complex script font info. Null means font is undefined and should be inherited from the Master.

Parameters:
value -

getRawSymbolFont

public FontDataEx getRawSymbolFont()
Returns the symbolic font info. Null means font is undefined and should be inherited from the Master.

Returns:
FontDataEx

setRawSymbolFont

public void setRawSymbolFont(FontDataEx value)
Sets the symbolic font info. Null means font is undefined and should be inherited from the Master.

Parameters:
value -

getRawEscapement

public float getRawEscapement()
Returns 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.

Returns:
The superscript or subscript text.

setRawEscapement

public void setRawEscapement(float value)
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.

Parameters:
value -

getRawKerningMinimalSize

public float getRawKerningMinimalSize()
Returns the minimal font size, for which kerning should be switched on. float.NaN means value is undefined and should be inherited from the Master.

Returns:
The minimal font size for kerning.

setRawKerningMinimalSize

public void setRawKerningMinimalSize(float value)
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.

Parameters:
value -

getRawLanguageId

public java.lang.String getRawLanguageId()
Returns the Id of a language.

Returns:
The Id of a language.

setRawLanguageId

public void setRawLanguageId(java.lang.String value)
Sets the Id of a language.

Parameters:
value -

getRawAlternativeLanguageId

public java.lang.String getRawAlternativeLanguageId()
Returns the Id of an alternative language.

Returns:
Id of an alternative language.

setRawAlternativeLanguageId

public void setRawAlternativeLanguageId(java.lang.String value)
Sets the Id of an alternative language.

Parameters:
value -

getRawSpacing

public float getRawSpacing()
Returns the spacing increment between characters. float.NaN means value is undefined and should be inherited from the Master.

Returns:
The spacing increment between characters.

setRawSpacing

public void setRawSpacing(float value)
Sets the spacing increment between characters. float.NaN means value is undefined and should be inherited from the Master.

Parameters:
value -

getSlide

public BaseSlideEx getSlide()
Returns the parent slide of a text.

Returns:
BaseSlideEx

getPresentation

public PresentationEx getPresentation()
Returns the parent presentation of a text.

Returns:
PresentationEx