CharacterProperties Class

Provides access to character properties.

Declaration

export class CharacterProperties

Properties

allCaps Property

Indicates whether all characters are capital letters.

Declaration

allCaps: boolean

Property Value

Type	Description
boolean	true if all characters are capitalized; otherwise, false or undefined for a mixture of true and false.

backColor Property

Specifies the background color of character(s).

Declaration

backColor: string

Property Value

Type	Description
string	The color value or undefined for mixed colors.

bold Property

Indicates whether characters are bold.

Declaration

bold: boolean

Property Value

Type	Description
boolean	true if characters are bold; otherwise, false or undefined for a mixture of true and false.

fontName Property

Specifies the character(s) font name.

Declaration

fontName: string

Property Value

Type	Description
string	The font name or undefined for a mixture of font names.

foreColor Property

Specifies the foreground color of character(s).

Declaration

foreColor: string

Property Value

Type	Description
string	The color value or undefined for mixed colors.

hidden Property

Indicates whether a character(s) is hidden.

Declaration

hidden: boolean

Property Value

Type	Description
boolean	true if characters are hidden; otherwise, false or undefined, for a mixture of true and false.

italic Property

Indicates whether characters are italicized.

Declaration

italic: boolean

Property Value

Type	Description
boolean	true if characters are italicized; otherwise, false or undefined for a mixture of true and false.

script Property

Specifies the character(s) script format.

Declaration

script: CharacterPropertiesScript

Property Value

Type	Description
CharacterPropertiesScript	The script format value or undefined for a mixture of formats.

size Property

Specifies the character(s) font size.

Declaration

size: number

Property Value

Type	Description
number	The font size in points or undefined for mixed sizes.

strikeout Property

Indicates whether characters are strikeout.

Declaration

strikeout: boolean

Property Value

Type	Description
boolean	true if characters are strikeout; otherwise, false or undefined for a mixture of true and false.

underline Property

Indicates whether characters are underlined.

Declaration

underline: boolean

Property Value

Type	Description
boolean	true if characters are underlined; otherwise, false or undefined for a mixture of true and false.

underlineColor Property

Specifies the color of the underline for the specified characters.

Declaration

underlineColor: string

Property Value

Type	Description
string	The color value or undefined for mixed colors.

underlineWordsOnly Property

Indicates whether all characters are underlined.

Declaration

underlineWordsOnly: boolean

Property Value

Type	Description
boolean	true if all characters are capitalized; otherwise, false or undefined for a mixture of true and false.