Class Font

Represents font properties such as family, size, and theme for text formatting.

Inheritance
System.Object
Font
Implements
IronSoftware.Abstractions.Word.IFont
IronSoftware.Abstractions.IFont
IronSoftware.Abstractions.IDocumentObject
System.ICloneable
Namespace: IronWord.Models
Assembly: IronWord.dll
Syntax
public class Font : Object

Font describes the typeface a run of text uses in a Word document, covering the font family, the per-script faces, and the embedded font data. A developer sets it on text styling to control which typeface renders, including separate faces for Latin, complex-script, and East Asian text in the same document.

A font is created with new Font() and configured through its properties, which group into three concerns. The named faces set the typeface directly: FontFamily and Name give the primary ASCII font, while HighAnsi, ComplexScript, and EastAsia set the faces for High ANSI, complex-script, and East Asian characters. The theme fonts let those faces follow a document theme instead of a fixed name: AsciiTheme, HighAnsiTheme, ComplexScriptTheme, and EastAsiaTheme each take a nullable ThemeFontValues, so leaving one null falls back to a named face. The embedding concern is read through IsEmbedded, which reports whether the font travels with the document, and FontData, which holds the raw font bytes.

Choosing between a named face and a theme font is the main decision when working with this type. A fixed FontFamily pins the typeface regardless of theme, while setting a theme font keeps the text in step with the document's theme as it changes. The per-script faces matter for multilingual documents, where Latin, complex-script, and East Asian text often need different typefaces. Clone produces an independent copy of a configured font, which is convenient when one base font is varied slightly across several styles without sharing a single mutable instance.

var font = new Font();
font.FontFamily = "Calibri";
font.EastAsia = "MS Mincho";

The add style text how-to applies fonts to text, the add style text example shows a worked styling pass, and the add text how-to covers placing the text itself.

Constructors

Font()

Declaration
public Font()

Properties

AsciiTheme

Gets or sets the ASCII theme font to be used for text.

Declaration
public Nullable<ThemeFontValues> AsciiTheme { get; set; }
Property Value
Type Description
System.Nullable<ThemeFontValues>

ComplexScript

Gets or sets the font for complex script text.

Declaration
public string ComplexScript { get; set; }
Property Value
Type Description
System.String

ComplexScriptTheme

Gets or sets the theme font to be used for complex script text.

Declaration
public Nullable<ThemeFontValues> ComplexScriptTheme { get; set; }
Property Value
Type Description
System.Nullable<ThemeFontValues>

EastAsia

Gets or sets the font for East Asian text.

Declaration
public string EastAsia { get; set; }
Property Value
Type Description
System.String

EastAsiaTheme

Gets or sets the theme font to be used for East Asian text.

Declaration
public Nullable<ThemeFontValues> EastAsiaTheme { get; set; }
Property Value
Type Description
System.Nullable<ThemeFontValues>

FontData

The byte data of the font.

Declaration
public byte[] FontData { get; set; }
Property Value
Type Description
System.Byte[]

FontFamily

Gets or sets the font family for the ASCII text.

Declaration
public string FontFamily { get; set; }
Property Value
Type Description
System.String

HighAnsi

Gets or sets the font for High ANSI characters.

Declaration
public string HighAnsi { get; set; }
Property Value
Type Description
System.String

HighAnsiTheme

Gets or sets the theme font to be used for High ANSI characters.

Declaration
public Nullable<ThemeFontValues> HighAnsiTheme { get; set; }
Property Value
Type Description
System.Nullable<ThemeFontValues>

IsEmbedded

Whether the font is embedded or not.

Declaration
public bool IsEmbedded { get; }
Property Value
Type Description
System.Boolean

Name

Name of the font.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

Methods

Clone()

Declaration
public object Clone()
Returns
Type Description
System.Object

Implements

IronSoftware.Abstractions.Word.IFont
IronSoftware.Abstractions.IFont
IronSoftware.Abstractions.IDocumentObject
System.ICloneable