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

All Implemented Interfaces:

IDocumentSerializable

public class CharacterFormat
extends WordAttrCollection

Constructor Summary

CharacterFormat(IDocument doc)
Default constructor

Method Summary

void	clearBackground() Clear the text background.
void	clearFormatting() Clear the text background.
boolean	getAllCaps() Gets or sets AllCaps property of text.
boolean	getAllowContextualAlternates() Gets or sets a value indicating whether to allow contextual alternates.
boolean	getBidi() Returns or sets right-to-left property of text.
boolean	getBold() Returns or sets bold style
boolean	getBoldBidi() Returns or sets bold property for right-to-left text.
Border	getBorder() Gets border.
float	getCharacterSpacing() Returns or sets space width between characters.
boolean	getDoubleStrike() Returns or sets double strikeout style.
boolean	getEmboss() Gets or sets emboss property of text.
Emphasis	getEmphasisMark() Returns or sets text emphasis mark
boolean	getEngrave() Gets or sets Engrave property of text.
com.spire.ms.System.Drawing.Font	getFont() Gets or sets font.
java.lang.String	getFontName() Returns or sets font name
java.lang.String	getFontNameAscii() Gets or setsthe font used for Latin text (characters with character codes from 0 through 127).
java.lang.String	getFontNameBidi() Gets or sets font name for right-to-left text.
java.lang.String	getFontNameFarEast() Gets or sets East Asian font name.
java.lang.String	getFontNameNonFarEast() Gets or sets font used for characters with character codes from 128 through 255.
float	getFontSize() Returns or sets font size
float	getFontSizeBidi() Returns or sets font size of the right-to-left text.
FontTypeHint	getFontTypeHint() Gets or sets the font type hint.
boolean	getHidden() Gets or sets Hidden property of text.
java.awt.Color	getHighlightColor() Gets or sets highlight color of text.
boolean	getItalic() Returns or sets italic style
boolean	getItalicBidi() Returns or sets italic property for right-to-left text.
LigatureType	getLigaturesType() Gets or sets the ligatures type.
short	getLocaleIdASCII() Gets or sets the ASCII locale id .
short	getLocaleIdFarEast() Gets or sets the far east locale id .
NumberFormType	getNumberFormType() Gets or sets the number form type.
NumberSpaceType	getNumberSpaceType() Gets or sets the number space type.
float	getPosition() Returns or sets text vertical position.
StylisticSetType	getStylisticSetType() Gets or sets the stylistic set type.
SubSuperScript	getSubSuperScript() Returns or setssubscript/superscript mode
java.awt.Color	getTextBackgroundColor() Gets or sets text background color
java.awt.Color	getTextColor() Returns or sets text color
TextEffectFormat	getTextEffectFormat() Returns text effect format
short	getTextScale() Gets or 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%.
UnderlineStyle	getUnderlineStyle() Returns or sets underline style
boolean	isOutLine() Get/set outline character property.
void	isOutLine(boolean value) Get/set outline character property.
boolean	isShadow() Gets or sets shadow property of text.
void	isShadow(boolean value) Gets or sets shadow property of text.
boolean	isSmallCaps() Gets or sets IsSmallCaps property of text.
void	isSmallCaps(boolean value) Gets or sets IsSmallCaps property of text.
boolean	isStrikeout() Returns or sets strikeout style.
void	isStrikeout(boolean value) Returns or sets strikeout style.
void	setAllCaps(boolean value) Gets or sets AllCaps property of text.
void	setAllowContextualAlternates(boolean value) Gets or sets a value indicating whether to allow contextual alternates.
void	setBidi(boolean value) Returns or sets right-to-left property of text.
void	setBold(boolean value) Returns or sets bold style
void	setBoldBidi(boolean value) Returns or sets bold property for right-to-left text.
void	setCharacterSpacing(float value) Returns or sets space width between characters.
void	setDoubleStrike(boolean value) Returns or sets double strikeout style.
void	setEmboss(boolean value) Gets or sets emboss property of text.
void	setEmphasisMark(Emphasis value) Returns or sets text emphasis mark
void	setEngrave(boolean value) Gets or sets Engrave property of text.
void	setFont(com.spire.ms.System.Drawing.Font value) Gets or sets font.
void	setFontName(java.lang.String value) Returns or sets font name
void	setFontNameAscii(java.lang.String value) Gets or setsthe font used for Latin text (characters with character codes from 0 through 127).
void	setFontNameBidi(java.lang.String value) Gets or sets font name for right-to-left text.
void	setFontNameFarEast(java.lang.String value) Gets or sets East Asian font name.
void	setFontNameNonFarEast(java.lang.String value) Gets or sets font used for characters with character codes from 128 through 255.
void	setFontSize(float value) Returns or sets font size
void	setFontSizeBidi(float value) Returns or sets font size of the right-to-left text.
void	setFontTypeHint(FontTypeHint value) Gets or sets the font type hint.
void	setHidden(boolean value) Gets or sets Hidden property of text.
void	setHighlightColor(java.awt.Color value) Gets or sets highlight color of text.
void	setItalic(boolean value) Returns or sets italic style
void	setItalicBidi(boolean value) Returns or sets italic property for right-to-left text.
void	setLigaturesType(LigatureType value) Gets or sets the ligatures type.
void	setLocaleIdASCII(short value) Gets or sets the ASCII locale id .
void	setLocaleIdFarEast(short value) Gets or sets the far east locale id .
void	setNumberFormType(NumberFormType value) Gets or sets the number form type.
void	setNumberSpaceType(NumberSpaceType value) Gets or sets the number space type.
void	setPosition(float value) Returns or sets text vertical position.
void	setStylisticSetType(StylisticSetType value) Gets or sets the stylistic set type.
void	setSubSuperScript(SubSuperScript value) Returns or setssubscript/superscript mode
void	setTextBackgroundColor(java.awt.Color value) Gets or sets text background color
void	setTextColor(java.awt.Color value) Returns or sets text color
void	setTextScale(short value) Gets or 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) Returns or sets underline style

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

hasKey, isDefault

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Constructor Detail

CharacterFormat

public CharacterFormat(IDocument doc)

Default constructor

Method Detail

getFont

public com.spire.ms.System.Drawing.Font getFont()

Gets or sets font.

setFont

public void setFont(com.spire.ms.System.Drawing.Font value)

Gets or sets font.

getFontName

public java.lang.String getFontName()

Returns or sets font name

setFontName

public void setFontName(java.lang.String value)

Returns or sets font name

getFontSize

public float getFontSize()

Returns or sets font size

setFontSize

public void setFontSize(float value)

Returns or sets font size

getBold

public boolean getBold()

Returns or sets bold style

setBold

public void setBold(boolean value)

Returns or sets bold style

getItalic

public boolean getItalic()

Returns or sets italic style

setItalic

public void setItalic(boolean value)

Returns or sets italic style

isStrikeout

public boolean isStrikeout()

Returns or sets strikeout style.

isStrikeout

public void isStrikeout(boolean value)

Returns or sets strikeout style.

getDoubleStrike

public boolean getDoubleStrike()

Returns or sets double strikeout style.

setDoubleStrike

public void setDoubleStrike(boolean value)

Returns or sets double strikeout style.

getUnderlineStyle

public UnderlineStyle getUnderlineStyle()

Returns or sets underline style

setUnderlineStyle

public void setUnderlineStyle(UnderlineStyle value)

Returns or sets underline style

getEmphasisMark

public Emphasis getEmphasisMark()

Returns or sets text emphasis mark

setEmphasisMark

public void setEmphasisMark(Emphasis value)

Returns or sets text emphasis mark

getTextColor

public java.awt.Color getTextColor()

Returns or sets text color

setTextColor

public void setTextColor(java.awt.Color value)

Returns or sets text color

getTextScale

public short getTextScale()

Gets or 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%.

setTextScale

public void setTextScale(short value)

Gets or 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%.

getTextBackgroundColor

public java.awt.Color getTextBackgroundColor()

Gets or sets text background color

setTextBackgroundColor

public void setTextBackgroundColor(java.awt.Color value)

Gets or sets text background color

getSubSuperScript

public SubSuperScript getSubSuperScript()

Returns or setssubscript/superscript mode

setSubSuperScript

public void setSubSuperScript(SubSuperScript value)

Returns or setssubscript/superscript mode

getCharacterSpacing

public float getCharacterSpacing()

Returns or sets space width between characters.

setCharacterSpacing

public void setCharacterSpacing(float value)

Returns or sets space width between characters.

getPosition

public float getPosition()

Returns or sets text vertical position.

setPosition

public void setPosition(float value)

Returns or sets text vertical position.

isShadow

public boolean isShadow()

Gets or sets shadow property of text.

isShadow

public void isShadow(boolean value)

Gets or sets shadow property of text.

getEmboss

public boolean getEmboss()

Gets or sets emboss property of text.

setEmboss

public void setEmboss(boolean value)

Gets or sets emboss property of text.

getEngrave

public boolean getEngrave()

Gets or sets Engrave property of text.

setEngrave

public void setEngrave(boolean value)

Gets or sets Engrave property of text.

getHidden

public boolean getHidden()

Gets or sets Hidden property of text.

setHidden

public void setHidden(boolean value)

Gets or sets Hidden property of text.

getAllCaps

public boolean getAllCaps()

Gets or sets AllCaps property of text.

setAllCaps

public void setAllCaps(boolean value)

Gets or sets AllCaps property of text.

isSmallCaps

public boolean isSmallCaps()

Gets or sets IsSmallCaps property of text.

isSmallCaps

public void isSmallCaps(boolean value)

Gets or sets IsSmallCaps property of text.

getBidi

public boolean getBidi()

Returns or sets right-to-left property of text.

setBidi

public void setBidi(boolean value)

Returns or sets right-to-left property of text.

getBoldBidi

public boolean getBoldBidi()

Returns or sets bold property for right-to-left text.

setBoldBidi

public void setBoldBidi(boolean value)

Returns or sets bold property for right-to-left text.

getItalicBidi

public boolean getItalicBidi()

Returns or sets italic property for right-to-left text.

setItalicBidi

public void setItalicBidi(boolean value)

Returns or sets italic property for right-to-left text.

getFontSizeBidi

public float getFontSizeBidi()

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

setFontSizeBidi

public void setFontSizeBidi(float value)

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

getHighlightColor

public java.awt.Color getHighlightColor()

Gets or sets highlight color of text.

setHighlightColor

public void setHighlightColor(java.awt.Color value)

Gets or sets highlight color of text.

getBorder

public Border getBorder()

Gets border.

getFontNameAscii

public java.lang.String getFontNameAscii()

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

setFontNameAscii

public void setFontNameAscii(java.lang.String value)

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

getFontNameBidi

public java.lang.String getFontNameBidi()

Gets or sets font name for right-to-left text.

setFontNameBidi

public void setFontNameBidi(java.lang.String value)

Gets or sets font name for right-to-left text.

getFontNameFarEast

public java.lang.String getFontNameFarEast()

Gets or sets East Asian font name.

setFontNameFarEast

public void setFontNameFarEast(java.lang.String value)

Gets or sets East Asian font name.

getFontNameNonFarEast

public java.lang.String getFontNameNonFarEast()

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

setFontNameNonFarEast

public void setFontNameNonFarEast(java.lang.String value)

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

getFontTypeHint

public FontTypeHint getFontTypeHint()

Gets or sets the font type hint.

setFontTypeHint

public void setFontTypeHint(FontTypeHint value)

Gets or sets the font type hint.

getLocaleIdASCII

public short getLocaleIdASCII()

Gets or sets the ASCII locale id .

Returns:

The ASCII locale id .

setLocaleIdASCII

public void setLocaleIdASCII(short value)

Gets or sets the ASCII locale id .

getLocaleIdFarEast

public short getLocaleIdFarEast()

Gets or sets the far east locale id .

Returns:

The far east locale id .

setLocaleIdFarEast

public void setLocaleIdFarEast(short value)

Gets or sets the far east locale id .

isOutLine

public boolean isOutLine()

Get/set outline character property.

isOutLine

public void isOutLine(boolean value)

Get/set outline character property.

getTextEffectFormat

public TextEffectFormat getTextEffectFormat()

Returns text effect format

getAllowContextualAlternates

public boolean getAllowContextualAlternates()

Gets or sets a value indicating whether to allow contextual alternates.

setAllowContextualAlternates

public void setAllowContextualAlternates(boolean value)

Gets or sets a value indicating whether to allow contextual alternates.

getLigaturesType

public LigatureType getLigaturesType()

Gets or sets the ligatures type.

setLigaturesType

public void setLigaturesType(LigatureType value)

Gets or sets the ligatures type.

getNumberFormType

public NumberFormType getNumberFormType()

Gets or sets the number form type.

Returns:

The number form.

setNumberFormType

public void setNumberFormType(NumberFormType value)

Gets or sets the number form type.

getNumberSpaceType

public NumberSpaceType getNumberSpaceType()

Gets or sets the number space type.

setNumberSpaceType

public void setNumberSpaceType(NumberSpaceType value)

Gets or sets the number space type.

getStylisticSetType

public StylisticSetType getStylisticSetType()

Gets or sets the stylistic set type.

setStylisticSetType

public void setStylisticSetType(StylisticSetType value)

Gets or sets the stylistic set type.

clearBackground

public void clearBackground()

Clear the text background.

Overrides:

clearBackground in class FormatBase

clearFormatting

public void clearFormatting()

Clear the text background.

Overrides:

clearFormatting in class FormatBase