Font (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.Font

```
public class Font
extends java.lang.Object
```
Contains font attributes (font name, font size, color, and so on) for an object.
You do not create instances of the Font class directly. You just use Font to access the font properties of the various objects such as Run, Paragraph, Style, DocumentBuilder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearFormatting()` Resets to default font formatting.
`java.lang.Object`	`fetchInheritedBorderAttr(int key)`
`java.lang.Object`	`fetchInheritedShadingAttr(int key)`
`boolean`	`getAllCaps()` True if the font is formatted as all capital letters.
`java.awt.Color`	`getAutoColor()` Returns the present calculated color of the text (black or white) to be used for 'auto color'.
`boolean`	`getBidi()` Specifies whether the contents of this run shall have right-to-left characteristics.
`boolean`	`getBold()` True if the font is formatted as bold.
`boolean`	`getBoldBi()` True if the right-to-left text is formatted as bold.
`Border`	`getBorder()` Returns a Border object that specifies border for the font.
`java.awt.Color`	`getColor()` Gets the color of the font.
`boolean`	`getComplexScript()` Specifies whether the contents of this run shall be treated as complex script text regardless of their Unicode character values when determining the formatting for this run.
`java.lang.Object`	`getDirectBorderAttr(int key)`
`boolean`	`getDoubleStrikeThrough()` True if the font is formatted as double strikethrough text.
`boolean`	`getEmboss()` True if the font is formatted as embossed.
`int`	`getEmphasisMark()` Gets the emphasis mark applied to this formatting.
`boolean`	`getEngrave()` True if the font is formatted as engraved.
`Fill`	`getFill()` Gets fill formatting for the Font.
`java.awt.Color`	`getFillableBackColor()`
`java.awt.Color`	`getFillableForeColor()`
`byte[]`	`getFillableImageBytes()`
`double`	`getFillableTransparency()`
`boolean`	`getFillableVisible()`
`java.awt.Color`	`getFilledColor()`
`int`	`getFillType()`
`double`	`getGradientAngle()`
`GradientStopCollection`	`getGradientStops()`
`int`	`getGradientStyle()`
`int`	`getGradientVariant()`
`boolean`	`getHidden()` True if the font is formatted as hidden text.
`java.awt.Color`	`getHighlightColor()` Gets the highlight (marker) color.
`boolean`	`getItalic()` True if the font is formatted as italic.
`boolean`	`getItalicBi()` True if the right-to-left text is formatted as italic.
`double`	`getKerning()` Gets the font size at which kerning starts.
`double`	`getLineSpacing()` Returns line spacing of this font (in points).
`int`	`getLocaleId()` Gets the locale identifier (language) of the formatted characters.
`int`	`getLocaleIdBi()` Gets the locale identifier (language) of the formatted right-to-left characters.
`int`	`getLocaleIdFarEast()` Gets the locale identifier (language) of the formatted Asian characters.
`java.lang.String`	`getName()` Gets the name of the font.
`java.lang.String`	`getNameAscii()` Gets the font used for Latin text (characters with character codes from 0 (zero) through 127).
`java.lang.String`	`getNameBi()` Gets the name of the font in a right-to-left language document.
`java.lang.String`	`getNameFarEast()` Gets an East Asian font name.
`java.lang.String`	`getNameOther()` Gets the font used for characters with character codes from 128 through 255.
`boolean`	`getNoProofing()` True when the formatted characters are not to be spell checked.
`boolean`	`getOn()`
`double`	`getOpacity()`
`boolean`	`getOutline()` True if the font is formatted as outline.
`int`	`getPatternType()`
`double`	`getPosition()` Gets the position of text (in points) relative to the base line.
`int`	`getPresetTexture()`
`boolean`	`getRotateWithObject()`
`int`	`getScaling()` Gets character width scaling in percent.
`Shading`	`getShading()` Returns a Shading object that refers to the shading formatting for the font.
`boolean`	`getShadow()` True if the font is formatted as shadowed.
`double`	`getSize()` Gets the font size in points.
`double`	`getSizeBi()` Gets the font size in points used in a right-to-left document.
`boolean`	`getSmallCaps()` True if the font is formatted as small capital letters.
`boolean`	`getSnapToGrid()` Specifies whether the current font should use the document grid characters per line settings when laying out.
`double`	`getSpacing()` Gets the spacing (in points) between characters .
`boolean`	`getStrikeThrough()` True if the font is formatted as strikethrough text.
`Style`	`getStyle()` Gets the character style applied to this formatting.
`int`	`getStyleIdentifier()` Gets the locale independent style identifier of the character style applied to this formatting.
`java.lang.String`	`getStyleName()` Gets the name of the character style applied to this formatting.
`boolean`	`getSubscript()` True if the font is formatted as subscript.
`boolean`	`getSuperscript()` True if the font is formatted as superscript.
`int`	`getTextEffect()` Gets the font animation effect.
`int`	`getTextureAlignment()`
`int`	`getThemeColor()` Gets the theme color in the applied color scheme that is associated with this Font object.
`int`	`getThemeFont()` Gets the theme font in the applied font scheme that is associated with this Font object.
`int`	`getThemeFontAscii()` Gets the theme font used for Latin text (characters with character codes from 0 (zero) through 127) in the applied font scheme that is associated with this Font object.
`int`	`getThemeFontBi()` Gets the theme font in the applied font scheme that is associated with this Font object in a right-to-left language document.
`int`	`getThemeFontFarEast()` Gets the East Asian theme font in the applied font scheme that is associated with this Font object.
`int`	`getThemeFontOther()` Gets the theme font used for characters with character codes from 128 through 255 in the applied font scheme that is associated with this Font object.
`double`	`getTintAndShade()` Gets a double value that lightens or darkens a color.
`int`	`getUnderline()` Gets the type of underline applied to the font.
`java.awt.Color`	`getUnderlineColor()` Gets the color of the underline applied to the font.
`boolean`	`hasDmlEffect(int dmlEffectType)`
`void`	`oneColorGradient(int style, int variant, double degree)`
`void`	`patterned(int patternType)`
`void`	`presetTextured(int presetTexture)`
`void`	`setAllCaps(boolean value)` True if the font is formatted as all capital letters.
`void`	`setBidi(boolean value)` Specifies whether the contents of this run shall have right-to-left characteristics.
`void`	`setBold(boolean value)` True if the font is formatted as bold.
`void`	`setBoldBi(boolean value)` True if the right-to-left text is formatted as bold.
`void`	`setBorderAttr(int key, java.lang.Object value)`
`void`	`setColor(java.awt.Color value)` Sets the color of the font.
`void`	`setComplexScript(boolean value)` Specifies whether the contents of this run shall be treated as complex script text regardless of their Unicode character values when determining the formatting for this run.
`void`	`setDoubleStrikeThrough(boolean value)` True if the font is formatted as double strikethrough text.
`void`	`setEmboss(boolean value)` True if the font is formatted as embossed.
`void`	`setEmphasisMark(int value)` Sets the emphasis mark applied to this formatting.
`void`	`setEngrave(boolean value)` True if the font is formatted as engraved.
`void`	`setFillableBackColor(java.awt.Color value)`
`void`	`setFillableForeColor(java.awt.Color value)`
`void`	`setFillableTransparency(double value)`
`void`	`setFillableVisible(boolean value)`
`void`	`setFilledColor(java.awt.Color value)`
`void`	`setGradientAngle(double value)`
`void`	`setHidden(boolean value)` True if the font is formatted as hidden text.
`void`	`setHighlightColor(java.awt.Color value)` Sets the highlight (marker) color.
`void`	`setImage(byte[] imageBytes)`
`void`	`setItalic(boolean value)` True if the font is formatted as italic.
`void`	`setItalicBi(boolean value)` True if the right-to-left text is formatted as italic.
`void`	`setKerning(double value)` Sets the font size at which kerning starts.
`void`	`setLocaleId(int value)` Sets the locale identifier (language) of the formatted characters.
`void`	`setLocaleIdBi(int value)` Sets the locale identifier (language) of the formatted right-to-left characters.
`void`	`setLocaleIdFarEast(int value)` Sets the locale identifier (language) of the formatted Asian characters.
`void`	`setName(java.lang.String value)` Sets the name of the font.
`void`	`setNameAscii(java.lang.String value)` Sets the font used for Latin text (characters with character codes from 0 (zero) through 127).
`void`	`setNameBi(java.lang.String value)` Sets the name of the font in a right-to-left language document.
`void`	`setNameFarEast(java.lang.String value)` Sets an East Asian font name.
`void`	`setNameOther(java.lang.String value)` Sets the font used for characters with character codes from 128 through 255.
`void`	`setNoProofing(boolean value)` True when the formatted characters are not to be spell checked.
`void`	`setOn(boolean value)`
`void`	`setOpacity(double value)`
`void`	`setOutline(boolean value)` True if the font is formatted as outline.
`void`	`setPosition(double value)` Sets the position of text (in points) relative to the base line.
`void`	`setRotateWithObject(boolean value)`
`void`	`setScaling(int value)` Sets character width scaling in percent.
`void`	`setShadow(boolean value)` True if the font is formatted as shadowed.
`void`	`setSize(double value)` Sets the font size in points.
`void`	`setSizeBi(double value)` Sets the font size in points used in a right-to-left document.
`void`	`setSmallCaps(boolean value)` True if the font is formatted as small capital letters.
`void`	`setSnapToGrid(boolean value)` Specifies whether the current font should use the document grid characters per line settings when laying out.
`void`	`setSpacing(double value)` Sets the spacing (in points) between characters .
`void`	`setStrikeThrough(boolean value)` True if the font is formatted as strikethrough text.
`void`	`setStyle(Style value)` Sets the character style applied to this formatting.
`void`	`setStyleIdentifier(int value)` Sets the locale independent style identifier of the character style applied to this formatting.
`void`	`setStyleName(java.lang.String value)` Sets the name of the character style applied to this formatting.
`void`	`setSubscript(boolean value)` True if the font is formatted as subscript.
`void`	`setSuperscript(boolean value)` True if the font is formatted as superscript.
`void`	`setTextEffect(int value)` Sets the font animation effect.
`void`	`setTextureAlignment(int value)`
`void`	`setThemeColor(int value)` Sets the theme color in the applied color scheme that is associated with this Font object.
`void`	`setThemeFont(int value)` Sets the theme font in the applied font scheme that is associated with this Font object.
`void`	`setThemeFontAscii(int value)` Sets the theme font used for Latin text (characters with character codes from 0 (zero) through 127) in the applied font scheme that is associated with this Font object.
`void`	`setThemeFontBi(int value)` Sets the theme font in the applied font scheme that is associated with this Font object in a right-to-left language document.
`void`	`setThemeFontFarEast(int value)` Sets the East Asian theme font in the applied font scheme that is associated with this Font object.
`void`	`setThemeFontOther(int value)` Sets the theme font used for characters with character codes from 128 through 255 in the applied font scheme that is associated with this Font object.
`void`	`setTintAndShade(double value)` Sets a double value that lightens or darkens a color.
`void`	`setUnderline(int value)` Sets the type of underline applied to the font.
`void`	`setUnderlineColor(java.awt.Color value)` Sets the color of the underline applied to the font.
`void`	`solid()`
`void`	`twoColorGradient(int style, int variant)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - clearFormatting
```
public void clearFormatting()
```
    Resets to default font formatting.
    Removes all font formatting specified explicitly on the object from which Font was obtained so the font formatting will be inherited from the appropriate parent.
  - getName
```
public java.lang.String getName()
```
    Gets the name of the font.
    When getting, returns getNameAscii() / setNameAscii(java.lang.String).
    
    When setting, sets getNameAscii() / setNameAscii(java.lang.String), getNameBi() / setNameBi(java.lang.String), getNameFarEast() / setNameFarEast(java.lang.String) and getNameOther() / setNameOther(java.lang.String) to the specified value.
    
    Returns:
    
    The name of the font.
  - setName
```
public void setName(java.lang.String value)
```
    Sets the name of the font.
    When getting, returns getNameAscii() / setNameAscii(java.lang.String).
    
    When setting, sets getNameAscii() / setNameAscii(java.lang.String), getNameBi() / setNameBi(java.lang.String), getNameFarEast() / setNameFarEast(java.lang.String) and getNameOther() / setNameOther(java.lang.String) to the specified value.
    
    Parameters:
    
    value - The name of the font.
  - getNameAscii
```
public java.lang.String getNameAscii()
```
    Gets the font used for Latin text (characters with character codes from 0 (zero) through 127).
    
    Returns:
    
    The font used for Latin text (characters with character codes from 0 (zero) through 127).
    
    See Also:
    
    getName(), setName(java.lang.String)
  - setNameAscii
```
public void setNameAscii(java.lang.String value)
```
    Sets the font used for Latin text (characters with character codes from 0 (zero) through 127).
    
    Parameters:
    
    value - The font used for Latin text (characters with character codes from 0 (zero) through 127).
    
    See Also:
    
    getName(), setName(java.lang.String)
  - getNameBi
```
public java.lang.String getNameBi()
```
    Gets the name of the font in a right-to-left language document.
    
    Returns:
    
    The name of the font in a right-to-left language document.
    
    See Also:
    
    getName(), setName(java.lang.String)
  - setNameBi
```
public void setNameBi(java.lang.String value)
```
    Sets the name of the font in a right-to-left language document.
    
    Parameters:
    
    value - The name of the font in a right-to-left language document.
    
    See Also:
    
    getName(), setName(java.lang.String)
  - getNameFarEast
```
public java.lang.String getNameFarEast()
```
    Gets an East Asian font name.
    
    Returns:
    
    An East Asian font name.
    
    See Also:
    
    getName(), setName(java.lang.String)
  - setNameFarEast
```
public void setNameFarEast(java.lang.String value)
```
    Sets an East Asian font name.
    
    Parameters:
    
    value - An East Asian font name.
    
    See Also:
    
    getName(), setName(java.lang.String)
  - getNameOther
```
public java.lang.String getNameOther()
```
    Gets the font used for characters with character codes from 128 through 255.
    
    Returns:
    
    The font used for characters with character codes from 128 through 255.
    
    See Also:
    
    getName(), setName(java.lang.String)
  - setNameOther
```
public void setNameOther(java.lang.String value)
```
    Sets the font used for characters with character codes from 128 through 255.
    
    Parameters:
    
    value - The font used for characters with character codes from 128 through 255.
    
    See Also:
    
    getName(), setName(java.lang.String)
  - getThemeFont
```
public int getThemeFont()
```
    Gets the theme font in the applied font scheme that is associated with this Font object.
    
    Returns:
    
    The theme font in the applied font scheme that is associated with this Font object. The returned value is one of ThemeFont constants.
  - setThemeFont
```
public void setThemeFont(int value)
```
    Sets the theme font in the applied font scheme that is associated with this Font object.
    
    Parameters:
    
    value - The theme font in the applied font scheme that is associated with this Font object. The value must be one of ThemeFont constants.
  - getThemeFontAscii
```
public int getThemeFontAscii()
```
    Gets the theme font used for Latin text (characters with character codes from 0 (zero) through 127) in the applied font scheme that is associated with this Font object.
    
    Returns:
    
    The theme font used for Latin text (characters with character codes from 0 (zero) through 127) in the applied font scheme that is associated with this Font object. The returned value is one of ThemeFont constants.
  - setThemeFontAscii
```
public void setThemeFontAscii(int value)
```
    Sets the theme font used for Latin text (characters with character codes from 0 (zero) through 127) in the applied font scheme that is associated with this Font object.
    
    Parameters:
    
    value - The theme font used for Latin text (characters with character codes from 0 (zero) through 127) in the applied font scheme that is associated with this Font object. The value must be one of ThemeFont constants.
  - getThemeFontFarEast
```
public int getThemeFontFarEast()
```
    Gets the East Asian theme font in the applied font scheme that is associated with this Font object.
    
    Returns:
    
    The East Asian theme font in the applied font scheme that is associated with this Font object. The returned value is one of ThemeFont constants.
  - setThemeFontFarEast
```
public void setThemeFontFarEast(int value)
```
    Sets the East Asian theme font in the applied font scheme that is associated with this Font object.
    
    Parameters:
    
    value - The East Asian theme font in the applied font scheme that is associated with this Font object. The value must be one of ThemeFont constants.
  - getThemeFontOther
```
public int getThemeFontOther()
```
    Gets the theme font used for characters with character codes from 128 through 255 in the applied font scheme that is associated with this Font object.
    
    Returns:
    
    The theme font used for characters with character codes from 128 through 255 in the applied font scheme that is associated with this Font object. The returned value is one of ThemeFont constants.
  - setThemeFontOther
```
public void setThemeFontOther(int value)
```
    Sets the theme font used for characters with character codes from 128 through 255 in the applied font scheme that is associated with this Font object.
    
    Parameters:
    
    value - The theme font used for characters with character codes from 128 through 255 in the applied font scheme that is associated with this Font object. The value must be one of ThemeFont constants.
  - getThemeFontBi
```
public int getThemeFontBi()
```
    Gets the theme font in the applied font scheme that is associated with this Font object in a right-to-left language document.
    
    Returns:
    
    The theme font in the applied font scheme that is associated with this Font object in a right-to-left language document. The returned value is one of ThemeFont constants.
  - setThemeFontBi
```
public void setThemeFontBi(int value)
```
    Sets the theme font in the applied font scheme that is associated with this Font object in a right-to-left language document.
    
    Parameters:
    
    value - The theme font in the applied font scheme that is associated with this Font object in a right-to-left language document. The value must be one of ThemeFont constants.
  - getSize
```
public double getSize()
```
    Gets the font size in points.
    
    Returns:
    
    The font size in points.
  - setSize
```
public void setSize(double value)
```
    Sets the font size in points.
    
    Parameters:
    
    value - The font size in points.
  - getSizeBi
```
public double getSizeBi()
```
    Gets the font size in points used in a right-to-left document.
    
    Returns:
    
    The font size in points used in a right-to-left document.
  - setSizeBi
```
public void setSizeBi(double value)
```
    Sets the font size in points used in a right-to-left document.
    
    Parameters:
    
    value - The font size in points used in a right-to-left document.
  - getBold
```
public boolean getBold()
```
    True if the font is formatted as bold.
    
    Returns:
    
    The corresponding boolean value.
  - setBold
```
public void setBold(boolean value)
```
    True if the font is formatted as bold.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getBoldBi
```
public boolean getBoldBi()
```
    True if the right-to-left text is formatted as bold.
    
    Returns:
    
    The corresponding boolean value.
  - setBoldBi
```
public void setBoldBi(boolean value)
```
    True if the right-to-left text is formatted as bold.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getItalic
```
public boolean getItalic()
```
    True if the font is formatted as italic.
    
    Returns:
    
    The corresponding boolean value.
  - setItalic
```
public void setItalic(boolean value)
```
    True if the font is formatted as italic.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getItalicBi
```
public boolean getItalicBi()
```
    True if the right-to-left text is formatted as italic.
    
    Returns:
    
    The corresponding boolean value.
  - setItalicBi
```
public void setItalicBi(boolean value)
```
    True if the right-to-left text is formatted as italic.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getColor
```
public java.awt.Color getColor()
```
    Gets the color of the font.
    
    Returns:
    
    The color of the font.
  - setColor
```
public void setColor(java.awt.Color value)
```
    Sets the color of the font.
    
    Parameters:
    
    value - The color of the font.
  - getThemeColor
```
public int getThemeColor()
```
    Gets the theme color in the applied color scheme that is associated with this Font object.
    
    Returns:
    
    The theme color in the applied color scheme that is associated with this Font object. The returned value is one of ThemeColor constants.
  - setThemeColor
```
public void setThemeColor(int value)
```
    Sets the theme color in the applied color scheme that is associated with this Font object.
    
    Parameters:
    
    value - The theme color in the applied color scheme that is associated with this Font object. The value must be one of ThemeColor constants.
  - getTintAndShade
```
public double getTintAndShade()
```
    Gets a double value that lightens or darkens a color.
    The allowed values are in range from -1 (darkest) to 1 (lightest) for this property. Zero (0) is neutral. Attempting to set this property to a value less than -1 or more than 1 results in a IllegalArgumentException.
    
    Setting this property for Font object with non-theme colors results in a IllegalStateException.
    
    Returns:
    
    A double value that lightens or darkens a color.
  - setTintAndShade
```
public void setTintAndShade(double value)
```
    Sets a double value that lightens or darkens a color.
    The allowed values are in range from -1 (darkest) to 1 (lightest) for this property. Zero (0) is neutral. Attempting to set this property to a value less than -1 or more than 1 results in a IllegalArgumentException.
    
    Setting this property for Font object with non-theme colors results in a IllegalStateException.
    
    Parameters:
    
    value - A double value that lightens or darkens a color.
  - getAutoColor
```
public java.awt.Color getAutoColor()
                            throws java.lang.Exception
```
    Returns the present calculated color of the text (black or white) to be used for 'auto color'. If the color is not 'auto' then returns getColor() / setColor(java.awt.Color).
    When text has 'automatic color', the actual color of text is calculated automatically so that it is readable against the background color. As you change the background color, the text color will automatically switch to black or white in MS Word to maximize legibility.
    
    Returns:
    
    The present calculated color of the text (black or white) to be used for 'auto color'.
    
    Throws:
    
    java.lang.Exception
  - getStrikeThrough
```
public boolean getStrikeThrough()
```
    True if the font is formatted as strikethrough text.
    
    Returns:
    
    The corresponding boolean value.
  - setStrikeThrough
```
public void setStrikeThrough(boolean value)
```
    True if the font is formatted as strikethrough text.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getDoubleStrikeThrough
```
public boolean getDoubleStrikeThrough()
```
    True if the font is formatted as double strikethrough text.
    
    Returns:
    
    The corresponding boolean value.
  - setDoubleStrikeThrough
```
public void setDoubleStrikeThrough(boolean value)
```
    True if the font is formatted as double strikethrough text.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getShadow
```
public boolean getShadow()
```
    True if the font is formatted as shadowed.
    
    Returns:
    
    The corresponding boolean value.
  - setShadow
```
public void setShadow(boolean value)
```
    True if the font is formatted as shadowed.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getOutline
```
public boolean getOutline()
```
    True if the font is formatted as outline.
    
    Returns:
    
    The corresponding boolean value.
  - setOutline
```
public void setOutline(boolean value)
```
    True if the font is formatted as outline.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getEmboss
```
public boolean getEmboss()
```
    True if the font is formatted as embossed.
    
    Returns:
    
    The corresponding boolean value.
  - setEmboss
```
public void setEmboss(boolean value)
```
    True if the font is formatted as embossed.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getEngrave
```
public boolean getEngrave()
```
    True if the font is formatted as engraved.
    
    Returns:
    
    The corresponding boolean value.
  - setEngrave
```
public void setEngrave(boolean value)
```
    True if the font is formatted as engraved.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getSuperscript
```
public boolean getSuperscript()
```
    True if the font is formatted as superscript.
    
    Returns:
    
    The corresponding boolean value.
  - setSuperscript
```
public void setSuperscript(boolean value)
```
    True if the font is formatted as superscript.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getSubscript
```
public boolean getSubscript()
```
    True if the font is formatted as subscript.
    
    Returns:
    
    The corresponding boolean value.
  - setSubscript
```
public void setSubscript(boolean value)
```
    True if the font is formatted as subscript.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getSmallCaps
```
public boolean getSmallCaps()
```
    True if the font is formatted as small capital letters.
    
    Returns:
    
    The corresponding boolean value.
  - setSmallCaps
```
public void setSmallCaps(boolean value)
```
    True if the font is formatted as small capital letters.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getAllCaps
```
public boolean getAllCaps()
```
    True if the font is formatted as all capital letters.
    
    Returns:
    
    The corresponding boolean value.
  - setAllCaps
```
public void setAllCaps(boolean value)
```
    True if the font is formatted as all capital letters.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getHidden
```
public boolean getHidden()
```
    True if the font is formatted as hidden text.
    
    Returns:
    
    The corresponding boolean value.
  - setHidden
```
public void setHidden(boolean value)
```
    True if the font is formatted as hidden text.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getUnderline
```
public int getUnderline()
```
    Gets the type of underline applied to the font.
    
    Returns:
    
    The type of underline applied to the font. The returned value is one of Underline constants.
  - setUnderline
```
public void setUnderline(int value)
```
    Sets the type of underline applied to the font.
    
    Parameters:
    
    value - The type of underline applied to the font. The value must be one of Underline constants.
  - getUnderlineColor
```
public java.awt.Color getUnderlineColor()
```
    Gets the color of the underline applied to the font.
    
    Returns:
    
    The color of the underline applied to the font.
  - setUnderlineColor
```
public void setUnderlineColor(java.awt.Color value)
```
    Sets the color of the underline applied to the font.
    
    Parameters:
    
    value - The color of the underline applied to the font.
  - getScaling
```
public int getScaling()
```
    Gets character width scaling in percent.
    
    Returns:
    
    Character width scaling in percent.
  - setScaling
```
public void setScaling(int value)
```
    Sets character width scaling in percent.
    
    Parameters:
    
    value - Character width scaling in percent.
  - getSpacing
```
public double getSpacing()
```
    Gets the spacing (in points) between characters .
    
    Returns:
    
    The spacing (in points) between characters .
  - setSpacing
```
public void setSpacing(double value)
```
    Sets the spacing (in points) between characters .
    
    Parameters:
    
    value - The spacing (in points) between characters .
  - getLineSpacing
```
public double getLineSpacing()
```
    Returns line spacing of this font (in points).
    
    Returns:
    
    Line spacing of this font (in points).
  - getPosition
```
public double getPosition()
```
    Gets the position of text (in points) relative to the base line. A positive number raises the text, and a negative number lowers it.
    
    Returns:
    
    The position of text (in points) relative to the base line.
  - setPosition
```
public void setPosition(double value)
```
    Sets the position of text (in points) relative to the base line. A positive number raises the text, and a negative number lowers it.
    
    Parameters:
    
    value - The position of text (in points) relative to the base line.
  - getKerning
```
public double getKerning()
```
    Gets the font size at which kerning starts.
    
    Returns:
    
    The font size at which kerning starts.
  - setKerning
```
public void setKerning(double value)
```
    Sets the font size at which kerning starts.
    
    Parameters:
    
    value - The font size at which kerning starts.
  - getHighlightColor
```
public java.awt.Color getHighlightColor()
```
    Gets the highlight (marker) color.
    
    Returns:
    
    The highlight (marker) color.
  - setHighlightColor
```
public void setHighlightColor(java.awt.Color value)
```
    Sets the highlight (marker) color.
    
    Parameters:
    
    value - The highlight (marker) color.
  - getTextEffect
```
public int getTextEffect()
```
    Gets the font animation effect.
    
    Returns:
    
    The font animation effect. The returned value is one of TextEffect constants.
  - setTextEffect
```
public void setTextEffect(int value)
```
    Sets the font animation effect.
    
    Parameters:
    
    value - The font animation effect. The value must be one of TextEffect constants.
  - getFill
```
public Fill getFill()
```
    Gets fill formatting for the Font.
    
    Returns:
    
    Fill formatting for the Font.
  - hasDmlEffect
```
public boolean hasDmlEffect(int dmlEffectType)
```
  - getBidi
```
public boolean getBidi()
```
    Specifies whether the contents of this run shall have right-to-left characteristics.
    This property, when on, shall not be used with strongly left-to-right text. Any behavior under that condition is unspecified. This property, when off, shall not be used with strong right-to-left text. Any behavior under that condition is unspecified.
    
    When the contents of this run are displayed, all characters shall be treated as complex script characters for formatting purposes. This means that getBoldBi() / setBoldBi(boolean), getItalicBi() / setItalicBi(boolean), getSizeBi() / setSizeBi(double) and a corresponding font name will be used when rendering this run.
    
    Also, when the contents of this run are displayed, this property acts as a right-to-left override for characters which are classified as "weak types" and "neutral types".
    
    Returns:
    
    The corresponding boolean value.
  - setBidi
```
public void setBidi(boolean value)
```
    Specifies whether the contents of this run shall have right-to-left characteristics.
    This property, when on, shall not be used with strongly left-to-right text. Any behavior under that condition is unspecified. This property, when off, shall not be used with strong right-to-left text. Any behavior under that condition is unspecified.
    
    When the contents of this run are displayed, all characters shall be treated as complex script characters for formatting purposes. This means that getBoldBi() / setBoldBi(boolean), getItalicBi() / setItalicBi(boolean), getSizeBi() / setSizeBi(double) and a corresponding font name will be used when rendering this run.
    
    Also, when the contents of this run are displayed, this property acts as a right-to-left override for characters which are classified as "weak types" and "neutral types".
    
    Parameters:
    
    value - The corresponding boolean value.
  - getComplexScript
```
public boolean getComplexScript()
```
    Specifies whether the contents of this run shall be treated as complex script text regardless of their Unicode character values when determining the formatting for this run.
    
    Returns:
    
    The corresponding boolean value.
  - setComplexScript
```
public void setComplexScript(boolean value)
```
    Specifies whether the contents of this run shall be treated as complex script text regardless of their Unicode character values when determining the formatting for this run.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getNoProofing
```
public boolean getNoProofing()
```
    True when the formatted characters are not to be spell checked.
    
    Returns:
    
    The corresponding boolean value.
  - setNoProofing
```
public void setNoProofing(boolean value)
```
    True when the formatted characters are not to be spell checked.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getLocaleId
```
public int getLocaleId()
```
    Gets the locale identifier (language) of the formatted characters. For the list of locale identifiers see https://msdn.microsoft.com/en-us/library/cc233965.aspx
    
    Returns:
    
    The locale identifier (language) of the formatted characters.
  - setLocaleId
```
public void setLocaleId(int value)
```
    Sets the locale identifier (language) of the formatted characters. For the list of locale identifiers see https://msdn.microsoft.com/en-us/library/cc233965.aspx
    
    Parameters:
    
    value - The locale identifier (language) of the formatted characters.
  - getLocaleIdBi
```
public int getLocaleIdBi()
```
    Gets the locale identifier (language) of the formatted right-to-left characters. For the list of locale identifiers see https://msdn.microsoft.com/en-us/library/cc233965.aspx
    
    Returns:
    
    The locale identifier (language) of the formatted right-to-left characters.
  - setLocaleIdBi
```
public void setLocaleIdBi(int value)
```
    Sets the locale identifier (language) of the formatted right-to-left characters. For the list of locale identifiers see https://msdn.microsoft.com/en-us/library/cc233965.aspx
    
    Parameters:
    
    value - The locale identifier (language) of the formatted right-to-left characters.
  - getLocaleIdFarEast
```
public int getLocaleIdFarEast()
```
    Gets the locale identifier (language) of the formatted Asian characters. For the list of locale identifiers see https://msdn.microsoft.com/en-us/library/cc233965.aspx
    
    Returns:
    
    The locale identifier (language) of the formatted Asian characters.
  - setLocaleIdFarEast
```
public void setLocaleIdFarEast(int value)
```
    Sets the locale identifier (language) of the formatted Asian characters. For the list of locale identifiers see https://msdn.microsoft.com/en-us/library/cc233965.aspx
    
    Parameters:
    
    value - The locale identifier (language) of the formatted Asian characters.
  - getBorder
```
public Border getBorder()
```
    Returns a Border object that specifies border for the font.
    
    Returns:
    
    A Border object that specifies border for the font.
  - getShading
```
public Shading getShading()
```
    Returns a Shading object that refers to the shading formatting for the font.
    
    Returns:
    
    A Shading object that refers to the shading formatting for the font.
  - getStyle
```
public Style getStyle()
```
    Gets the character style applied to this formatting.
    
    Returns:
    
    The character style applied to this formatting.
  - setStyle
```
public void setStyle(Style value)
```
    Sets the character style applied to this formatting.
    
    Parameters:
    
    value - The character style applied to this formatting.
  - getStyleName
```
public java.lang.String getStyleName()
```
    Gets the name of the character style applied to this formatting.
    
    Returns:
    
    The name of the character style applied to this formatting.
  - setStyleName
```
public void setStyleName(java.lang.String value)
```
    Sets the name of the character style applied to this formatting.
    
    Parameters:
    
    value - The name of the character style applied to this formatting.
  - getStyleIdentifier
```
public int getStyleIdentifier()
```
    Gets the locale independent style identifier of the character style applied to this formatting.
    
    Returns:
    
    The locale independent style identifier of the character style applied to this formatting. The returned value is one of StyleIdentifier constants.
  - setStyleIdentifier
```
public void setStyleIdentifier(int value)
```
    Sets the locale independent style identifier of the character style applied to this formatting.
    
    Parameters:
    
    value - The locale independent style identifier of the character style applied to this formatting. The value must be one of StyleIdentifier constants.
  - getSnapToGrid
```
public boolean getSnapToGrid()
```
    Specifies whether the current font should use the document grid characters per line settings when laying out.
    
    Returns:
    
    The corresponding boolean value.
  - setSnapToGrid
```
public void setSnapToGrid(boolean value)
```
    Specifies whether the current font should use the document grid characters per line settings when laying out.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getEmphasisMark
```
public int getEmphasisMark()
```
    Gets the emphasis mark applied to this formatting.
    
    Returns:
    
    The emphasis mark applied to this formatting. The returned value is one of EmphasisMark constants.
  - setEmphasisMark
```
public void setEmphasisMark(int value)
```
    Sets the emphasis mark applied to this formatting.
    
    Parameters:
    
    value - The emphasis mark applied to this formatting. The value must be one of EmphasisMark constants.
  - getDirectBorderAttr
```
public java.lang.Object getDirectBorderAttr(int key)
```
  - fetchInheritedBorderAttr
```
public java.lang.Object fetchInheritedBorderAttr(int key)
```
  - setBorderAttr
```
public void setBorderAttr(int key,
                          java.lang.Object value)
```
  - fetchInheritedShadingAttr
```
public java.lang.Object fetchInheritedShadingAttr(int key)
```
  - solid
```
public void solid()
```
  - getPresetTexture
```
public int getPresetTexture()
```
  - getPatternType
```
public int getPatternType()
```
  - presetTextured
```
public void presetTextured(int presetTexture)
```
  - patterned
```
public void patterned(int patternType)
```
  - twoColorGradient
```
public void twoColorGradient(int style,
                             int variant)
```
  - oneColorGradient
```
public void oneColorGradient(int style,
                             int variant,
                             double degree)
```
  - setImage
```
public void setImage(byte[] imageBytes)
```
  - getFilledColor
```
public java.awt.Color getFilledColor()
```
  - setFilledColor
```
public void setFilledColor(java.awt.Color value)
```
  - getOn
```
public boolean getOn()
```
  - setOn
```
public void setOn(boolean value)
```
  - getOpacity
```
public double getOpacity()
```
  - setOpacity
```
public void setOpacity(double value)
```
  - getFillableImageBytes
```
public byte[] getFillableImageBytes()
```
  - getTextureAlignment
```
public int getTextureAlignment()
```
  - setTextureAlignment
```
public void setTextureAlignment(int value)
```
  - getGradientAngle
```
public double getGradientAngle()
```
  - setGradientAngle
```
public void setGradientAngle(double value)
```
  - getGradientVariant
```
public int getGradientVariant()
```
  - getGradientStyle
```
public int getGradientStyle()
```
  - getGradientStops
```
public GradientStopCollection getGradientStops()
```
  - getFillableForeColor
```
public java.awt.Color getFillableForeColor()
```
  - setFillableForeColor
```
public void setFillableForeColor(java.awt.Color value)
```
  - getFillableBackColor
```
public java.awt.Color getFillableBackColor()
```
  - setFillableBackColor
```
public void setFillableBackColor(java.awt.Color value)
```
  - getFillableVisible
```
public boolean getFillableVisible()
```
  - setFillableVisible
```
public void setFillableVisible(boolean value)
```
  - getFillableTransparency
```
public double getFillableTransparency()
```
  - setFillableTransparency
```
public void setFillableTransparency(double value)
```
  - getRotateWithObject
```
public boolean getRotateWithObject()
```
  - setRotateWithObject
```
public void setRotateWithObject(boolean value)
```
  - getFillType
```
public int getFillType()
```

Class Font

Method Summary

Methods inherited from class java.lang.Object

Method Detail

clearFormatting

getName

setName

getNameAscii

setNameAscii

getNameBi

setNameBi

getNameFarEast

setNameFarEast

getNameOther

setNameOther

getThemeFont

setThemeFont

getThemeFontAscii

setThemeFontAscii

getThemeFontFarEast

setThemeFontFarEast

getThemeFontOther

setThemeFontOther

getThemeFontBi

setThemeFontBi

getSize

setSize

getSizeBi

setSizeBi

getBold

setBold

getBoldBi

setBoldBi

getItalic

setItalic

getItalicBi

setItalicBi

getColor

setColor

getThemeColor

setThemeColor

getTintAndShade

setTintAndShade

getAutoColor

getStrikeThrough

setStrikeThrough

getDoubleStrikeThrough

setDoubleStrikeThrough

getShadow

setShadow

getOutline

setOutline

getEmboss

setEmboss

getEngrave

setEngrave

getSuperscript

setSuperscript

getSubscript

setSubscript

getSmallCaps

setSmallCaps

getAllCaps

setAllCaps

getHidden

setHidden

getUnderline

setUnderline

getUnderlineColor

setUnderlineColor

getScaling

setScaling

getSpacing

setSpacing

getLineSpacing

getPosition

setPosition

getKerning

setKerning

getHighlightColor