com.spire.doc.formatting
Class CharacterFormat

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.formatting.FormatBase
              com.spire.doc.formatting.AttrCollection
                  com.spire.doc.formatting.WordAttrCollection
                      com.spire.doc.formatting.CharacterFormat

public class CharacterFormat
extends WordAttrCollection

Constructor Summary

CharacterFormat(IDocument doc)
Default constructor

Method Summary

boolean	getAllCaps() Gets AllCaps property of text.
boolean	getAllowContextualAlternates() Gets a value indicating whether to allow contextual alternates.
boolean	getBidi() Returns right-to-left property of text.
boolean	getBold() Returns bold style
boolean	getBoldBidi() Returns bold property for right-to-left text.
Border	getBorder() Gets border.
float	getCharacterSpacing() Returns space width between characters.
boolean	getDoubleStrike() Returns double strikeout style.
boolean	getEmboss() Gets emboss property of text.
Emphasis	getEmphasisMark() Returns text emphasis mark
boolean	getEngrave() Gets Engrave property of text.
java.lang.String	getFontName() Returns font name
java.lang.String	getFontNameAscii() Gets the font used for Latin text (characters with character codes from 0 through 127).
java.lang.String	getFontNameBidi() Gets font name for right-to-left text.
java.lang.String	getFontNameFarEast() Gets East Asian font name.
java.lang.String	getFontNameNonFarEast() Gets font used for characters with character codes from 128 through 255.
float	getFontSize() Returns font size
float	getFontSizeBidi() Returns font size of the right-to-left text.
FontTypeHint	getFontTypeHint() Gets the font type hint.
boolean	getHidden() Gets Hidden property of text.
java.awt.Color	getHighlightColor() Gets highlight color of text.
boolean	getItalic() Returns italic style
boolean	getItalicBidi() Returns italic property for right-to-left text.
LigatureType	getLigaturesType() Gets the ligatures type.
short	getLocaleIdASCII() Gets the ASCII locale id .
short	getLocaleIdFarEast() Gets the far east locale id .
NumberFormType	getNumberFormType() Gets the number form type.
NumberSpaceType	getNumberSpaceType() Gets the number space type.
float	getPosition() Returns text vertical position.
StylisticSetType	getStylisticSetType() Gets the stylistic set type.
SubSuperScript	getSubSuperScript() Returns subscript/superscript mode
java.awt.Color	getTextBackgroundColor() Returns text background color
java.awt.Color	getTextColor() Returns text color
short	getTextScale() Gets a value specifies that the percentage by which the contents of a run shall be expanded or compressed with respect to its normal(100%) character width,with a minimun width of 1% and maximum width of 600%.
UnderlineStyle	getUnderlineStyle() Returns underline style
boolean	isOutLine() Get outline character property.
void	isOutLine(boolean value) Set outline character property.
boolean	isShadow() Gets shadow property of text.
void	isShadow(boolean value) Sets shadow property of text.
boolean	isSmallCaps() Gets IsSmallCaps property of text.
void	isSmallCaps(boolean value) Sets IsSmallCaps property of text.
boolean	isStrikeout() Returns strikeout style.
void	isStrikeout(boolean value) Sets strikeout style.
void	setAllCaps(boolean value) Sets AllCaps property of text.
void	setAllowContextualAlternates(boolean value) Sets a value indicating whether to allow contextual alternates.
void	setBidi(boolean value) Sets right-to-left property of text.
void	setBold(boolean value) Sets bold style
void	setBoldBidi(boolean value) Sets bold property for right-to-left text.
void	setCharacterSpacing(float value) Sets space width between characters.
void	setDoubleStrike(boolean value) Sets double strikeout style.
void	setEmboss(boolean value) Sets emboss property of text.
void	setEmphasisMark(Emphasis value) Sets text emphasis mark
void	setEngrave(boolean value) Sets Engrave property of text.
void	setFontName(java.lang.String value) Sets font name
void	setFontNameAscii(java.lang.String value) Sets the font used for Latin text (characters with character codes from 0 through 127).
void	setFontNameBidi(java.lang.String value) Sets font name for right-to-left text.
void	setFontNameFarEast(java.lang.String value) Sets East Asian font name.
void	setFontNameNonFarEast(java.lang.String value) Sets font used for characters with character codes from 128 through 255.
void	setFontSize(float value) Sets font size
void	setFontSizeBidi(float value) Sets font size of the right-to-left text.
void	setFontTypeHint(FontTypeHint value) Sets the font type hint.
void	setHidden(boolean value) Sets Hidden property of text.
void	setHighlightColor(java.awt.Color value) Sets highlight color of text.
void	setItalic(boolean value) Sets italic style
void	setItalicBidi(boolean value) Sets italic property for right-to-left text.
void	setLigaturesType(LigatureType value) Sets the ligatures type.
void	setLocaleIdASCII(short value) Sets the ASCII locale id .
void	setLocaleIdFarEast(short value) Sets the far east locale id .
void	setNumberFormType(NumberFormType value) Sets the number form type.
void	setNumberSpaceType(NumberSpaceType value) Sets the number space type.
void	setPosition(float value) Sets text vertical position.
void	setStylisticSetType(StylisticSetType value) Sets the stylistic set type.
void	setSubSuperScript(SubSuperScript value) Sets subscript/superscript mode
void	setTextBackgroundColor(java.awt.Color value) Sets text background color
void	setTextColor(java.awt.Color value) Sets text color
void	setTextScale(short value) Sets a value specifies that the percentage by which the contents of a run shall be expanded or compressed with respect to its normal(100%) character width,with a minimun width of 1% and maximum width of 600%.
void	setUnderlineStyle(UnderlineStyle value) Sets underline style

Methods inherited from class com.spire.doc.formatting.FormatBase

clearFormatting, hasKey, isDefault

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Constructor Detail

CharacterFormat

public CharacterFormat(IDocument doc)

Default constructor

Parameters:

doc - IDocument

Method Detail

getFontName

public java.lang.String getFontName()

Returns font name

Returns:

font name

setFontName

public void setFontName(java.lang.String value)

Sets font name

Parameters:

value - font name

getFontSize

public float getFontSize()

Returns font size

Returns:

font size

setFontSize

public void setFontSize(float value)

Sets font size

Parameters:

value - font size

getBold

public boolean getBold()

Returns bold style

Returns:

is bold or not

setBold

public void setBold(boolean value)

Sets bold style

Parameters:

value - is bold or not

getItalic

public boolean getItalic()

Returns italic style

Returns:

is italic or not

setItalic

public void setItalic(boolean value)

Sets italic style

Parameters:

value - is italic or not

isStrikeout

public boolean isStrikeout()

Returns strikeout style.

Returns:

strikeout style.

isStrikeout

public void isStrikeout(boolean value)

Sets strikeout style.

Parameters:

value - strikeout style.

getDoubleStrike

public boolean getDoubleStrike()

Returns double strikeout style.

Returns:

double strikeout style.

setDoubleStrike

public void setDoubleStrike(boolean value)

Sets double strikeout style.

Parameters:

value - double strikeout style.

getUnderlineStyle

public UnderlineStyle getUnderlineStyle()

Returns underline style

Returns:

underline style

setUnderlineStyle

public void setUnderlineStyle(UnderlineStyle value)

Sets underline style

Parameters:

value - underline style

getEmphasisMark

public Emphasis getEmphasisMark()

Returns text emphasis mark

Returns:

Emphasis

setEmphasisMark

public void setEmphasisMark(Emphasis value)

Sets text emphasis mark

Parameters:

value - Emphasis

getTextColor

public java.awt.Color getTextColor()

Returns text color

Returns:

text color

setTextColor

public void setTextColor(java.awt.Color value)

Sets text color

Parameters:

value - text color

getTextScale

public short getTextScale()

Gets a value specifies that the percentage by which the contents of a run shall be expanded or compressed with respect to its normal(100%) character width,with a minimun width of 1% and maximum width of 600%.

Returns:

textScale value

setTextScale

public void setTextScale(short value)

Sets a value specifies that the percentage by which the contents of a run shall be expanded or compressed with respect to its normal(100%) character width,with a minimun width of 1% and maximum width of 600%.

Parameters:

value - textScale value

getTextBackgroundColor

public java.awt.Color getTextBackgroundColor()

Returns text background color

Returns:

background color

setTextBackgroundColor

public void setTextBackgroundColor(java.awt.Color value)

Sets text background color

Parameters:

value - background color

getSubSuperScript

public SubSuperScript getSubSuperScript()

Returns subscript/superscript mode

Returns:

SubSuperScript

setSubSuperScript

public void setSubSuperScript(SubSuperScript value)

Sets subscript/superscript mode

Parameters:

value - SubSuperScript

getCharacterSpacing

public float getCharacterSpacing()

Returns space width between characters.

Returns:

CharacterSpacing

setCharacterSpacing

public void setCharacterSpacing(float value)

Sets space width between characters.

Parameters:

value - CharacterSpacing

getPosition

public float getPosition()

Returns text vertical position.

Returns:

Position

setPosition

public void setPosition(float value)

Sets text vertical position.

Parameters:

value - Position

isShadow

public boolean isShadow()

Gets shadow property of text.

Returns:

is shadow or not

isShadow

public void isShadow(boolean value)

Sets shadow property of text.

Parameters:

value - is shadow or not

getEmboss

public boolean getEmboss()

Gets emboss property of text.

Returns:

is emboss or not

setEmboss

public void setEmboss(boolean value)

Sets emboss property of text.

Parameters:

value - is emboss or not

getEngrave

public boolean getEngrave()

Gets Engrave property of text.

Returns:

is Engrave or not

setEngrave

public void setEngrave(boolean value)

Sets Engrave property of text.

Parameters:

value - is Engrave or not

getHidden

public boolean getHidden()

Gets Hidden property of text.

Returns:

is hidden or not

setHidden

public void setHidden(boolean value)

Sets Hidden property of text.

Parameters:

value - is hidden or not

getAllCaps

public boolean getAllCaps()

Gets AllCaps property of text.

Returns:

is allcaps or not

setAllCaps

public void setAllCaps(boolean value)

Sets AllCaps property of text.

Parameters:

value - is allcaps or not

isSmallCaps

public boolean isSmallCaps()

Gets IsSmallCaps property of text.

Returns:

is SmallCaps or not

isSmallCaps

public void isSmallCaps(boolean value)

Sets IsSmallCaps property of text.

Parameters:

value - is SmallCaps or not

getBidi

public boolean getBidi()

Returns right-to-left property of text.

Returns:

is bidi or not

setBidi

public void setBidi(boolean value)

Sets right-to-left property of text.

Parameters:

value - is bidi or not

getBoldBidi

public boolean getBoldBidi()

Returns bold property for right-to-left text.

Returns:

is BoldBidi or not

setBoldBidi

public void setBoldBidi(boolean value)

Sets bold property for right-to-left text.

Parameters:

value - is BoldBidi or not

getItalicBidi

public boolean getItalicBidi()

Returns italic property for right-to-left text.

Returns:

is ItalicBidi or not

setItalicBidi

public void setItalicBidi(boolean value)

Sets italic property for right-to-left text.

Parameters:

value - is ItalicBidi or not

getFontSizeBidi

public float getFontSizeBidi()

Returns font size of the right-to-left text.

Returns:

font size bidi

setFontSizeBidi

public void setFontSizeBidi(float value)

Sets font size of the right-to-left text.

Parameters:

value - font size bidi

getHighlightColor

public java.awt.Color getHighlightColor()

Gets highlight color of text.

Returns:

higlight color

setHighlightColor

public void setHighlightColor(java.awt.Color value)

Sets highlight color of text.

Parameters:

value - higlight color

getBorder

public Border getBorder()

Gets border.

Returns:

border

getFontNameAscii

public java.lang.String getFontNameAscii()

Gets the font used for Latin text (characters with character codes from 0 through 127).

Returns:

font name ascii

setFontNameAscii

public void setFontNameAscii(java.lang.String value)

Sets the font used for Latin text (characters with character codes from 0 through 127).

Parameters:

value - font name ascii

getFontNameBidi

public java.lang.String getFontNameBidi()

Gets font name for right-to-left text.

Returns:

font name bidi

setFontNameBidi

public void setFontNameBidi(java.lang.String value)

Sets font name for right-to-left text.

Parameters:

value - font name bidi

getFontNameFarEast

public java.lang.String getFontNameFarEast()

Gets East Asian font name.

Returns:

font name FarEast

setFontNameFarEast

public void setFontNameFarEast(java.lang.String value)

Sets East Asian font name.

Parameters:

value - font name FarEast

getFontNameNonFarEast

public java.lang.String getFontNameNonFarEast()

Gets font used for characters with character codes from 128 through 255.

Returns:

font name NonFarEast

setFontNameNonFarEast

public void setFontNameNonFarEast(java.lang.String value)

Sets font used for characters with character codes from 128 through 255.

Parameters:

value - font name NonFarEast

getFontTypeHint

public FontTypeHint getFontTypeHint()

Gets the font type hint.

Returns:

FontTypeHint

setFontTypeHint

public void setFontTypeHint(FontTypeHint value)

Sets the font type hint.

Parameters:

value - FontTypeHint

getLocaleIdASCII

public short getLocaleIdASCII()

Gets the ASCII locale id .

Returns:

LocaleIdASCII

setLocaleIdASCII

public void setLocaleIdASCII(short value)

Sets the ASCII locale id .

Parameters:

value - LocaleIdASCII

getLocaleIdFarEast

public short getLocaleIdFarEast()

Gets the far east locale id .

Returns:

LocaleIdFarEast

setLocaleIdFarEast

public void setLocaleIdFarEast(short value)

Sets the far east locale id .

Parameters:

value - LocaleIdFarEast

isOutLine

public boolean isOutLine()

Get outline character property.

Returns:

is outline or not

isOutLine

public void isOutLine(boolean value)

Set outline character property.

Parameters:

value - is outline or not

getAllowContextualAlternates

public boolean getAllowContextualAlternates()

Gets a value indicating whether to allow contextual alternates.

Returns:

AllowContextualAlternates

setAllowContextualAlternates

public void setAllowContextualAlternates(boolean value)

Sets a value indicating whether to allow contextual alternates.

Parameters:

value - AllowContextualAlternates

getLigaturesType

public LigatureType getLigaturesType()

Gets the ligatures type.

Returns:

LigatureType

setLigaturesType

public void setLigaturesType(LigatureType value)

Sets the ligatures type.

Parameters:

value - LigatureType

getNumberFormType

public NumberFormType getNumberFormType()

Gets the number form type.

Returns:

NumberFormType

setNumberFormType

public void setNumberFormType(NumberFormType value)

Sets the number form type.

Parameters:

value - NumberFormType

getNumberSpaceType

public NumberSpaceType getNumberSpaceType()

Gets the number space type.

Returns:

NumberSpaceType

setNumberSpaceType

public void setNumberSpaceType(NumberSpaceType value)

Sets the number space type.

Parameters:

value - NumberSpaceType

getStylisticSetType

public StylisticSetType getStylisticSetType()

Gets the stylistic set type.

Returns:

StylisticSetType

setStylisticSetType

public void setStylisticSetType(StylisticSetType value)

Sets the stylistic set type.

Parameters:

value - StylisticSetType