TextOptions

Inheritance: java.lang.Object, com.aspose.cells.Font

public class TextOptions extends Font

Represents the text options.

Methods

Method	Description
equals(Font font)	Checks if two fonts are equals.
equals(Object arg0)
getArgbColor()	Gets the color with a 32-bit ARGB value.
getCapsType()	Gets the text caps type.
getCharset()	Represent the character set.
getClass()
getColor()	Gets the Color of the font.
getDoubleSize()	Gets the double size of the font.
getFarEastName()	Gets the FarEast name.
getFill()	Represents the fill format of the text.
getKerning()	Specifies the minimum font size at which character kerning will occur for this text run.
getLanguageCode()	Gets the user interface language.
getLatinName()	Gets the latin name.
getName()	Gets the name of the shape.
getOutline()	Represents the outline format of the text.
getSchemeType()	Gets the scheme type of the font.
getScriptOffset()	Gets the script offset,in unit of percentage
getShadow()	Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
getSize()	Gets the size of the font.
getSpacing()	Specifies the spacing between characters within a text run.
getStrikeType()	Gets the strike type of the text.
getThemeColor()	Gets the theme color.
getUnderline()	Gets the font underline type.
getUnderlineColor()	Gets the color of underline.
hashCode()
isBold()	Gets a value indicating whether the font is bold.
isItalic()	Gets a value indicating whether the font is italic.
isNormalizeHeights()	Indicates whether the normalization of height that is to be applied to the text run.
isStrikeout()	Gets a value indicating whether the font is single strikeout.
isSubscript()	Gets a value indicating whether the font is subscript.
isSuperscript()	Gets a value indicating whether the font is super script.
notify()
notifyAll()
setArgbColor(int value)	Sets the color with a 32-bit ARGB value.
setBold(boolean value)	Sets a value indicating whether the font is bold.
setCapsType(int value)	Sets the text caps type.
setCharset(int value)	Represent the character set.
setColor(Color value)	Sets the Color of the font.
setDoubleSize(double value)	Sets the double size of the font.
setFarEastName(String value)	Sets the FarEast name.
setItalic(boolean value)	Sets a value indicating whether the font is italic.
setKerning(double value)	Specifies the minimum font size at which character kerning will occur for this text run.
setLanguageCode(int value)	Sets the user interface language.
setLatinName(String value)	Sets the latin name.
setName(String value)	Sets the name of the shape.
setName(String name, int type)	Sets name and scheme of the font.
setNormalizeHeights(boolean value)	Indicates whether the normalization of height that is to be applied to the text run.
setSchemeType(int value)	Sets the scheme type of the font.
setScriptOffset(double value)	Sets the script offset,in unit of percentage
setSize(int value)	Sets the size of the font.
setSpacing(double value)	Specifies the spacing between characters within a text run.
setStrikeType(int value)	Gets the strike type of the text.
setStrikeout(boolean value)	Sets a value indicating whether the font is single strikeout.
setSubscript(boolean value)	Sets a value indicating whether the font is subscript.
setSuperscript(boolean value)	Sets a value indicating whether the font is super script.
setThemeColor(ThemeColor value)	Sets the theme color.
setUnderline(int value)	Sets the font underline type.
setUnderlineColor(CellsColor value)	Sets the color of underline.
toString()	Returns a string represents the current Cell object.
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Font font)

public boolean equals(Font font)

Checks if two fonts are equals.

Parameters:

Parameter	Type	Description
font	Font	Compared font object.

Returns: boolean - True if equal to the compared font object.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getArgbColor()

public int getArgbColor()

Gets the color with a 32-bit ARGB value.

Returns: int

getCapsType()

public int getCapsType()

Gets the text caps type.

See TextCapsType.

Returns: int

getCharset()

public int getCharset()

Represent the character set.

Returns: int

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getColor()

public Color getColor()

Gets the Color of the font.

Returns: Color

getDoubleSize()

public double getDoubleSize()

Gets the double size of the font.

Returns: double

getFarEastName()

public String getFarEastName()

Gets the FarEast name.

Returns: java.lang.String

getFill()

public FillFormat getFill()

Represents the fill format of the text.

Returns: FillFormat

getKerning()

public double getKerning()

Specifies the minimum font size at which character kerning will occur for this text run.

Returns: double

getLanguageCode()

public int getLanguageCode()

Gets the user interface language.

See CountryCode.

Returns: int

getLatinName()

public String getLatinName()

Gets the latin name.

Returns: java.lang.String

getName()

public String getName()

Gets the name of the shape.

Returns: java.lang.String

getOutline()

public LineFormat getOutline()

Represents the outline format of the text.

Returns: LineFormat

getSchemeType()

public int getSchemeType()

Gets the scheme type of the font.

See FontSchemeType.

Returns: int

getScriptOffset()

public double getScriptOffset()

Gets the script offset,in unit of percentage

Remarks

Only for shapes and charts.

Returns: double

getShadow()

public ShadowEffect getShadow()

Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.

Returns: ShadowEffect

getSize()

public int getSize()

Gets the size of the font.

Returns: int

getSpacing()

public double getSpacing()

Specifies the spacing between characters within a text run.

Returns: double

getStrikeType()

public int getStrikeType()

Gets the strike type of the text.

See TextStrikeType.

Returns: int

getThemeColor()

public ThemeColor getThemeColor()

Gets the theme color.

Remarks

If the font color is not a theme color, NULL will be returned.

Returns: ThemeColor

getUnderline()

public int getUnderline()

Gets the font underline type.

See FontUnderlineType.

Returns: int

getUnderlineColor()

public CellsColor getUnderlineColor()

Gets the color of underline.

Returns: CellsColor

hashCode()

public native int hashCode()

Returns: int

isBold()

public boolean isBold()

Gets a value indicating whether the font is bold.

Returns: boolean

isItalic()

public boolean isItalic()

Gets a value indicating whether the font is italic.

Returns: boolean

isNormalizeHeights()

public boolean isNormalizeHeights()

Indicates whether the normalization of height that is to be applied to the text run.

Remarks

Only for the fonts of Shapes or Charts.

Returns: boolean

isStrikeout()

public boolean isStrikeout()

Gets a value indicating whether the font is single strikeout.

Returns: boolean

isSubscript()

public boolean isSubscript()

Gets a value indicating whether the font is subscript.

Returns: boolean

isSuperscript()

public boolean isSuperscript()

Gets a value indicating whether the font is super script.

Returns: boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setArgbColor(int value)

public void setArgbColor(int value)

Sets the color with a 32-bit ARGB value.

Parameters:

Parameter	Type	Description
value	int

setBold(boolean value)

public void setBold(boolean value)

Sets a value indicating whether the font is bold.

Parameters:

Parameter	Type	Description
value	boolean

setCapsType(int value)

public void setCapsType(int value)

Sets the text caps type.

See TextCapsType.

Parameters:

Parameter	Type	Description
value	int

setCharset(int value)

public void setCharset(int value)

Represent the character set.

Parameters:

Parameter	Type	Description
value	int

setColor(Color value)

public void setColor(Color value)

Sets the Color of the font.

Parameters:

Parameter	Type	Description
value	Color

setDoubleSize(double value)

public void setDoubleSize(double value)

Sets the double size of the font.

Parameters:

Parameter	Type	Description
value	double

setFarEastName(String value)

public void setFarEastName(String value)

Sets the FarEast name.

Parameters:

Parameter	Type	Description
value	java.lang.String

setItalic(boolean value)

public void setItalic(boolean value)

Sets a value indicating whether the font is italic.

Parameters:

Parameter	Type	Description
value	boolean

setKerning(double value)

public void setKerning(double value)

Specifies the minimum font size at which character kerning will occur for this text run.

Parameters:

Parameter	Type	Description
value	double

setLanguageCode(int value)

public void setLanguageCode(int value)

Sets the user interface language.

See CountryCode.

Parameters:

Parameter	Type	Description
value	int

setLatinName(String value)

public void setLatinName(String value)

Sets the latin name.

Parameters:

Parameter	Type	Description
value	java.lang.String

setName(String value)

public void setName(String value)

Sets the name of the shape.

Parameters:

Parameter	Type	Description
value	java.lang.String

setName(String name, int type)

public void setName(String name, int type)

Sets name and scheme of the font.

Parameters:

Parameter	Type	Description
name	java.lang.String
type	int	FontSchemeType.

setNormalizeHeights(boolean value)

public void setNormalizeHeights(boolean value)

Indicates whether the normalization of height that is to be applied to the text run.

Remarks

Only for the fonts of Shapes or Charts.

Parameters:

Parameter	Type	Description
value	boolean

setSchemeType(int value)

public void setSchemeType(int value)

Sets the scheme type of the font.

See FontSchemeType.

Parameters:

Parameter	Type	Description
value	int

setScriptOffset(double value)

public void setScriptOffset(double value)

Sets the script offset,in unit of percentage

Remarks

Only for shapes and charts.

Parameters:

Parameter	Type	Description
value	double

setSize(int value)

public void setSize(int value)

Sets the size of the font.

Parameters:

Parameter	Type	Description
value	int

setSpacing(double value)

public void setSpacing(double value)

Specifies the spacing between characters within a text run.

Parameters:

Parameter	Type	Description
value	double

setStrikeType(int value)

public void setStrikeType(int value)

Gets the strike type of the text.

See TextStrikeType.

Parameters:

Parameter	Type	Description
value	int

setStrikeout(boolean value)

public void setStrikeout(boolean value)

Sets a value indicating whether the font is single strikeout.

Parameters:

Parameter	Type	Description
value	boolean

setSubscript(boolean value)

public void setSubscript(boolean value)

Sets a value indicating whether the font is subscript.

Parameters:

Parameter	Type	Description
value	boolean

setSuperscript(boolean value)

public void setSuperscript(boolean value)

Sets a value indicating whether the font is super script.

Parameters:

Parameter	Type	Description
value	boolean

setThemeColor(ThemeColor value)

public void setThemeColor(ThemeColor value)

Sets the theme color.

Remarks

If the font color is not a theme color, NULL will be returned.

Parameters:

Parameter	Type	Description
value	ThemeColor

setUnderline(int value)

public void setUnderline(int value)

Sets the font underline type.

See FontUnderlineType.

Parameters:

Parameter	Type	Description
value	int

setUnderlineColor(CellsColor value)

public void setUnderlineColor(CellsColor value)

Sets the color of underline.

Parameters:

Parameter	Type	Description
value	CellsColor

toString()

public String toString()

Returns a string represents the current Cell object.

Returns: java.lang.String -

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int