java.lang.Objectcom.aspose.words.Font
public class Font
You do not create instances of the
Property Getters/Setters Summary | ||
---|---|---|
boolean | getAllCaps() | |
void | setAllCaps(boolean value) | |
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'.
If the color is not 'auto' then returns |
||
boolean | getBidi() | |
void | setBidi(boolean value) | |
Specifies whether the contents of this run shall have right-to-left characteristics. | ||
boolean | getBold() | |
void | setBold(boolean value) | |
True if the font is formatted as bold. | ||
boolean | getBoldBi() | |
void | setBoldBi(boolean value) | |
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 or sets the color of the font. | ||
boolean | getComplexScript() | |
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. | ||
boolean | getDoubleStrikeThrough() | |
void | setDoubleStrikeThrough(boolean value) | |
True if the font is formatted as double strikethrough text. | ||
boolean | getEmboss() | |
void | setEmboss(boolean value) | |
True if the font is formatted as embossed. | ||
boolean | getEngrave() | |
void | setEngrave(boolean value) | |
True if the font is formatted as engraved. | ||
boolean | getHidden() | |
void | setHidden(boolean value) | |
True if the font is formatted as hidden text. | ||
java.awt.Color | getHighlightColor() | |
Gets or sets the highlight (marker) color. | ||
boolean | getItalic() | |
void | setItalic(boolean value) | |
True if the font is formatted as italic. | ||
boolean | getItalicBi() | |
void | setItalicBi(boolean value) | |
True if the right-to-left text is formatted as italic. | ||
double | getKerning() | |
void | setKerning(double value) | |
Gets or sets the font size at which kerning starts. | ||
int | getLocaleId() | |
void | setLocaleId(int value) | |
Gets or sets the locale identifier (language) of the formatted characters. | ||
int | getLocaleIdBi() | |
void | setLocaleIdBi(int value) | |
Gets or sets the locale identifier (language) of the formatted right-to-left characters. | ||
int | getLocaleIdFarEast() | |
void | setLocaleIdFarEast(int value) | |
Gets or sets the locale identifier (language) of the formatted Asian characters. | ||
java.lang.String | getName() | |
void | setName(java.lang.String value) | |
Gets or sets the name of the font. | ||
java.lang.String | getNameAscii() | |
void | setNameAscii(java.lang.String value) | |
Returns or sets the font used for Latin text (characters with character codes from 0 (zero) through 127). | ||
java.lang.String | getNameBi() | |
void | setNameBi(java.lang.String value) | |
Returns or sets the name of the font in a right-to-left language document. | ||
java.lang.String | getNameFarEast() | |
void | setNameFarEast(java.lang.String value) | |
Returns or sets an East Asian font name. | ||
java.lang.String | getNameOther() | |
void | setNameOther(java.lang.String value) | |
Returns or sets the font used for characters with character codes from 128 through 255. | ||
boolean | getNoProofing() | |
void | setNoProofing(boolean value) | |
True when the formatted characters are not to be spell checked. | ||
boolean | getOutline() | |
void | setOutline(boolean value) | |
True if the font is formatted as outline. | ||
double | getPosition() | |
void | setPosition(double value) | |
Gets or sets the position of text (in points) relative to the base line. A positive number raises the text, and a negative number lowers it. | ||
int | getScaling() | |
void | setScaling(int value) | |
Gets or sets character width scaling in percent. | ||
Shading | getShading() | |
Returns a Shading object that refers to the shading formatting for the font. | ||
boolean | getShadow() | |
void | setShadow(boolean value) | |
True if the font is formatted as shadowed. | ||
double | getSize() | |
void | setSize(double value) | |
Gets or sets the font size in points. | ||
double | getSizeBi() | |
void | setSizeBi(double value) | |
Gets or sets the font size in points used in a right-to-left document. | ||
boolean | getSmallCaps() | |
void | setSmallCaps(boolean value) | |
True if the font is formatted as small capital letters. | ||
double | getSpacing() | |
void | setSpacing(double value) | |
Returns or sets the spacing (in points) between characters . | ||
boolean | getStrikeThrough() | |
void | setStrikeThrough(boolean value) | |
True if the font is formatted as strikethrough text. | ||
Style | getStyle() | |
void | setStyle(Style value) | |
Gets or sets the character style applied to this formatting. | ||
int | getStyleIdentifier() | |
void | setStyleIdentifier(int value) | |
Gets or sets the locale independent style identifier of the character style applied to this formatting. The value of the property is StyleIdentifier integer constant. | ||
java.lang.String | getStyleName() | |
void | setStyleName(java.lang.String value) | |
Gets or sets the name of the character style applied to this formatting. | ||
boolean | getSubscript() | |
void | setSubscript(boolean value) | |
True if the font is formatted as subscript. | ||
boolean | getSuperscript() | |
void | setSuperscript(boolean value) | |
True if the font is formatted as superscript. | ||
int | getTextEffect() | |
void | setTextEffect(int value) | |
Gets or sets the font animation effect. The value of the property is TextEffect integer constant. | ||
int | getUnderline() | |
void | setUnderline(int value) | |
Gets or sets the type of underline applied to the font. The value of the property is Underline integer constant. | ||
java.awt.Color | getUnderlineColor() | |
Gets or sets the color of the underline applied to the font. |
Method Summary | ||
---|---|---|
void | clearFormatting() | |
Resets to default font formatting. | ||
java.lang.Object | fetchInheritedBorderAttr(int key) | |
Reserved for internal use. | ||
java.lang.Object | fetchInheritedShadingAttr(int key) | |
Reserved for internal use. | ||
java.lang.Object | getDirectBorderAttr(int key) | |
Reserved for internal use. | ||
java.util.TreeMap | getPossibleBorderKeys() | |
Reserved for internal use. | ||
void | setBorderAttr(int key, java.lang.Object value) | |
Reserved for internal use. |
Property Getters/Setters Detail |
---|
getAllCaps/setAllCaps | |
public boolean getAllCaps() / public void setAllCaps(boolean value) |
getAutoColor | |
public java.awt.Color getAutoColor() |
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.
getBidi/setBidi | |
public boolean getBidi() / public void setBidi(boolean value) |
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
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".
getBold/setBold | |
public boolean getBold() / public void setBold(boolean value) |
getBoldBi/setBoldBi | |
public boolean getBoldBi() / public void setBoldBi(boolean value) |
getBorder | |
public Border getBorder() |
getColor | |
public java.awt.Color getColor() |
getComplexScript/setComplexScript | |
public boolean getComplexScript() / public void setComplexScript(boolean value) |
getDoubleStrikeThrough/setDoubleStrikeThrough | |
public boolean getDoubleStrikeThrough() / public void setDoubleStrikeThrough(boolean value) |
getEmboss/setEmboss | |
public boolean getEmboss() / public void setEmboss(boolean value) |
getEngrave/setEngrave | |
public boolean getEngrave() / public void setEngrave(boolean value) |
getHidden/setHidden | |
public boolean getHidden() / public void setHidden(boolean value) |
getHighlightColor | |
public java.awt.Color getHighlightColor() |
getItalic/setItalic | |
public boolean getItalic() / public void setItalic(boolean value) |
getItalicBi/setItalicBi | |
public boolean getItalicBi() / public void setItalicBi(boolean value) |
getKerning/setKerning | |
public double getKerning() / public void setKerning(double value) |
getLocaleId/setLocaleId | |
public int getLocaleId() / public void setLocaleId(int value) |
getLocaleIdBi/setLocaleIdBi | |
public int getLocaleIdBi() / public void setLocaleIdBi(int value) |
getLocaleIdFarEast/setLocaleIdFarEast | |
public int getLocaleIdFarEast() / public void setLocaleIdFarEast(int value) |
getName/setName | |
public java.lang.String getName() / public void setName(java.lang.String value) |
When getting, returns
When setting, sets
getNameAscii/setNameAscii | |
public java.lang.String getNameAscii() / public void setNameAscii(java.lang.String value) |
getNameBi/setNameBi | |
public java.lang.String getNameBi() / public void setNameBi(java.lang.String value) |
getNameFarEast/setNameFarEast | |
public java.lang.String getNameFarEast() / public void setNameFarEast(java.lang.String value) |
getNameOther/setNameOther | |
public java.lang.String getNameOther() / public void setNameOther(java.lang.String value) |
getNoProofing/setNoProofing | |
public boolean getNoProofing() / public void setNoProofing(boolean value) |
getOutline/setOutline | |
public boolean getOutline() / public void setOutline(boolean value) |
getPosition/setPosition | |
public double getPosition() / public void setPosition(double value) |
getScaling/setScaling | |
public int getScaling() / public void setScaling(int value) |
getShading | |
public Shading getShading() |
getShadow/setShadow | |
public boolean getShadow() / public void setShadow(boolean value) |
getSize/setSize | |
public double getSize() / public void setSize(double value) |
getSizeBi/setSizeBi | |
public double getSizeBi() / public void setSizeBi(double value) |
getSmallCaps/setSmallCaps | |
public boolean getSmallCaps() / public void setSmallCaps(boolean value) |
getSpacing/setSpacing | |
public double getSpacing() / public void setSpacing(double value) |
getStrikeThrough/setStrikeThrough | |
public boolean getStrikeThrough() / public void setStrikeThrough(boolean value) |
getStyle/setStyle | |
public Style getStyle() / public void setStyle(Style value) |
getStyleIdentifier/setStyleIdentifier | |
public int getStyleIdentifier() / public void setStyleIdentifier(int value) |
getStyleName/setStyleName | |
public java.lang.String getStyleName() / public void setStyleName(java.lang.String value) |
getSubscript/setSubscript | |
public boolean getSubscript() / public void setSubscript(boolean value) |
getSuperscript/setSuperscript | |
public boolean getSuperscript() / public void setSuperscript(boolean value) |
getTextEffect/setTextEffect | |
public int getTextEffect() / public void setTextEffect(int value) |
getUnderline/setUnderline | |
public int getUnderline() / public void setUnderline(int value) |
getUnderlineColor | |
public java.awt.Color getUnderlineColor() |
Method Detail |
---|
clearFormatting | |
public void clearFormatting() |
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.
fetchInheritedBorderAttr | |
public java.lang.Object fetchInheritedBorderAttr(int key) |
fetchInheritedShadingAttr | |
public java.lang.Object fetchInheritedShadingAttr(int key) |
getDirectBorderAttr | |
public java.lang.Object getDirectBorderAttr(int key) |
getPossibleBorderKeys | |
public java.util.TreeMap getPossibleBorderKeys() |
setBorderAttr | |
public void setBorderAttr(int key, java.lang.Object value) |