Abstract base class which controls the formatting of a range of characters in a [[FormattedString]] or [[FormattedText]].

Constructors

Section titled "Constructors"

FormattedFontBase 

new FormattedFontBase(a: IFormattedItem, b: number, c: number): FormattedFontBase

Returns FormattedFontBase

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

bold

Section titled "bold"

Gets or sets the value indicating whether the font is bold.

 
get bold(): boolean | null

Returns boolean | null 

set bold(a: boolean | null): void

Parameters

  • a: boolean | null

Returns void

colorInfo

Section titled "colorInfo"

Gets or sets the fore color of the font.

 
get colorInfo(): WorkbookColorInfo

Returns WorkbookColorInfo 

set colorInfo(a: WorkbookColorInfo): void

Parameters

Returns void

height

Section titled "height"

Gets or sets the height of the font.

 
get height(): number

Returns number 

set height(a: number): void

Parameters

  • a: number

Returns void

italic

Section titled "italic"

Gets or sets the value indicating whether the font is italic.

 
get italic(): boolean | null

Returns boolean | null 

set italic(a: boolean | null): void

Parameters

  • a: boolean | null

Returns void

length

Section titled "length"

Gets the number of characters covered by this font. Zero indicates the font controls from the [[startIndex]] to the end of the string. The number of characters covered by this font. Zero indicates the font controls from the StartIndex to the end of the string.

 
get length(): number

Returns number

name

Section titled "name"

Gets or sets the name of the font.

 
get name(): string

Returns string 

set name(a: string): void

Parameters

  • a: string

Returns void

startIndex

Section titled "startIndex"

Gets the index of the first character covered by this font. The index of the first character covered by this font.

 
get startIndex(): number

Returns number

strikeout

Section titled "strikeout"

Gets or sets the value indicating whether the font is struck out.

 
get strikeout(): boolean | null

Returns boolean | null 

set strikeout(a: boolean | null): void

Parameters

  • a: boolean | null

Returns void

superscriptSubscriptStyle

Section titled "superscriptSubscriptStyle"

Gets or sets the value indicating whether the font is superscript or subscript.

 
get superscriptSubscriptStyle(): FontSuperscriptSubscriptStyle

Returns FontSuperscriptSubscriptStyle 

set superscriptSubscriptStyle(a: FontSuperscriptSubscriptStyle): void

Parameters

Returns void

underlineStyle

Section titled "underlineStyle"

Gets or sets the underline style of the font.

 
get underlineStyle(): FontUnderlineStyle

Returns FontUnderlineStyle 

set underlineStyle(a: FontUnderlineStyle): void

Parameters

Returns void

Methods

Section titled "Methods"

setFontFormatting

Section titled "setFontFormatting"

Sets all properties of this font to the properties of the specified font.

 
setFontFormatting(source: IWorkbookFont): void

Parameters

  • source: IWorkbookFont

    The font whose properties should be copied over to this font.

Returns void