Skip to main content
A newer version of this page is available. .

ListLevelSettings Class

Contains settings to define individual list levels.

Declaration

export class ListLevelSettings

Properties

alignment Property

Gets or sets the paragraph text alignment within numbered list levels.

Declaration

alignment: ListLevelNumberAlignment

Property Value

Type Description
ListLevelNumberAlignment

The list level number alignment.

displayFormatString Property

Gets or sets the pattern used to format the list level for display purposes.

Declaration

displayFormatString: string

Property Value

Type Description
string

The format pattern.

firstLineIndent Property

Gets or sets a value specifying the indent of the first line of the current list level’s paragraph.

Declaration

firstLineIndent: number

Property Value

Type Description
number

The first line indent.

firstLineIndentType Property

Gets or sets a value specifying whether and how the first line of the current list level’s paragraph is indented.

Declaration

firstLineIndentType: ParagraphFirstLineIndent

Property Value

Type Description
ParagraphFirstLineIndent

The first line indent type.

fontBold Property

Gets or sets whether the font formatting of the current list level’s paragraph is bold.

Declaration

fontBold: boolean

Property Value

Type Description
boolean

true, if the font formatting is bold; otherwise, false.

fontColor Property

Gets or sets the font color of the current list level’s paragraph.

Declaration

fontColor: string

Property Value

Type Description
string

The font color.

fontItalic Property

Gets or sets whether the font is italicized.

Declaration

fontItalic: boolean

Property Value

Type Description
boolean

true, if the font is italicized; otherwise, false.

fontName Property

Gets or sets the font name of the current list level’s paragraph.

Declaration

fontName: string

Property Value

Type Description
string

The font name.

fontSize Property

Gets or sets the font size of the current list level’s paragraph.

Declaration

fontSize: number

Property Value

Type Description
number

The font size.

format Property

Gets or sets the numbering format used for the current list level’s paragraph.

Declaration

format: ListLevelFormat

Property Value

Type Description
ListLevelFormat

The list level format.

leftIndent Property

Gets or sets the left indent for text within the current list level’s paragraph.

Declaration

leftIndent: number

Property Value

Type Description
number

The left indent.

separator Property

Gets or sets the character inserted after the number for a numbered list item.

Declaration

separator: string

Property Value

Type Description
string

The trailing character for the list level.

Remarks

Only space and tab characters are valid values for the separator property.

start Property

Gets the list level item’s start position in the document.

Declaration

start: number

Property Value

Type Description
number

The start position.