Forums     Knowledge Base     OfficeWriter Online     
 
 
This documentation is for
OfficeWriter v3.8.1
.NET Platform

View Docs for Another
Version or Platform

Programmer's Reference > WordApplication API > Font

The Font Object


The Font class is used to specify formatting that should be applied to a character run. It also represents the fonts of named styles in the document.

There are two ways to obtain an instance of this class: Create a new Normal font object using Document.CreateFont(). This will return a copy of a particular style's font. The Font object that is returned can then be used in conjunction with methods in the Element class to create character runs, paragraphs, etc, with specific fonts.

The following example demonstrates both ways of getting a font, first by retrieving the Normal style's font from the document, second by retrieving a copy of the Heading1 style's font.



Font Enumerations

NameDescription
Font.Hyphenation

Types of hyphenation rules that can be applied to a character run

Font.ScriptType

Values used to represent whether a character run is formatting as superscript, subscript, or neither

Font.TextAnimation

Types of text animation that can be set on a character run

Font.UnderlineType

Types of underlines that can be applied to a character run



Font Properties

Property Type Access Description
Animation Font.TextAnimation read
write

Sets or returns a Font.TextAnimation object that represents the text animation for a character run

Bold boolean read
write

Sets or returns a boolean that represents if a character run is bolded

Border Border read

Returns an Border object on which you can manipulate the border properties of a character run

Caps boolean read
write

Sets or returns a boolean that represents if a character run has the All caps effect, formatting lowercase text as capital letters and reducing their size

CharacterScaling int read
write

Sets or returns an int that represents the character scaling, stretching or compressing text horizontally as a percentage of its current size

CharacterSpacing int read
write

Sets or returns an int that represents the spacing between characters in a character run in twips

DoubleStrike boolean read
write

Sets or returns a boolean that represents if a character run has the Double strikethrough effect, displaying a double line through the text

Embossed boolean read
write

Sets or returns a boolean that represents if a character run has the Emboss effect, displaying the text as if it is raised off the page in relief

Engraved boolean read
write

Sets or returns a boolean that represents if a character run has the Engrave effect, making the text to be imprinted or pressed into the page

FontName String read
write

Sets or returns a String that represents the name of the font used in this formatting

FontSize double read
write

Sets or returns an float that represents the font size for a character run

Hidden boolean read
write

Sets or returns a boolean that represents if a character run has the Hidden effect set

Highlight Color read
write

Sets or returns object that represents the color of the highlight for a character run

HyphenationRule Font.Hyphenation read
write

Sets or returns a Font.Hyphenation object that represents the hyphenation rule for a character run

Italic boolean read
write

Sets or returns a boolean that represents if a character run is italicized

Kerning double read
write

Sets or returns an double that represents the kerning threshold for a character run in points

NoProofChecking boolean read
write

Sets or returns a boolean that represents if Word will not perform grammar and spell checking on a character run when the document is opened

Outlined boolean read
write

Sets or returns a boolean that represents if a character run has the the Outline effect, displaying the inner and outer borders of each character

Shading Shading read

Returns an Shading object which on which you can manipulate the shading (fill color and/or pattern) properties of a character run

Shadow boolean read
write

Sets or returns a boolean that represents if a character run has the Shadow effect, displaying a shadow behind, beneath and to the right of each character

SmallCaps boolean read
write

Sets or returns a boolean that represents if a character run has the Small caps effect, formatting lowercase text as capital letters and reducing their size

Strike boolean read
write

Sets or returns a boolean that represents if a character run has the Strikethrough effect, displaying a single line through the text

SuperSubScript Font.ScriptType read
write

Sets or returns a ScriptType object that represents whether the text in this formatting is set to superscript, subscript, or none

TextColor Color read
write

Sets or returns object that represents the color of the text in a character run

Underline Font.UnderlineType read
write

Sets or returns a Font.UnderlineType object that represents the underline type for this formatting

UnderlineColor Color read
write

Sets or returns object that represents the color of the underline for a character run

VerticalPosition double read
write

Sets or returns an double that represents the vertical position for a character run in half points, lowering or raising the text in relation to the baseline



This object does not have any methods defined.



Copyright 2007 © SoftArtisans, Inc. All Rights Reserved.