Skip to main content

ListLevelSettings Class

Contains the list level’s properties.

Declaration

export class ListLevelSettings

Properties

alignment Property

Gets or sets the alignment of the list level’s number or bullet.

Declaration

alignment: ListLevelNumberAlignment

Property Value

Type Description
ListLevelNumberAlignment

The alignment.

displayFormatString Property

Gets or sets the pattern used to format the list level’s number or bullet.

Declaration

displayFormatString: string

Property Value

Type Description
string

The format pattern.

Remarks

The format pattern can include fixed literals and indexed placeholders.

An indexed placeholder is an integer from 0 to 8 enclosed in curly brackets (for instance, “{0}”). A placeholder index corresponds to the list level’s number or bullet depending on the format property value.

firstLineIndent Property

Gets or sets the first line indent of the list level’s paragraphs.

Declaration

firstLineIndent: number

Property Value

Type Description
number

The first line indent in twips.

firstLineIndentType Property

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

Declaration

firstLineIndentType: ParagraphFirstLineIndent

Property Value

Type Description
ParagraphFirstLineIndent

The first line’s indent type.

Remarks

When the firstLineIndentType property is set to Indented or Hanging, the firstLineIndent property determines the indent value.

fontBold Property

Gets or sets whether the list level’s number or bullet is bold.

Declaration

fontBold: boolean

Property Value

Type Description
boolean

true if the list level's number or bullet is bold; otherwise, false.

fontColor Property

Gets or sets the color of the list level’s number or bullet.

Declaration

fontColor: string

Property Value

Type Description
string

The color.

fontItalic Property

Gets or sets whether the list level’s number or bullet is italicized.

Declaration

fontItalic: boolean

Property Value

Type Description
boolean

true if the list level's number or bullet is italicized; otherwise, false.

fontName Property

Gets or sets the font name of the list level’s number or bullet.

Declaration

fontName: string

Property Value

Type Description
string

The font name.

fontSize Property

Gets or sets the font size of the list level’s number or bullet.

Declaration

fontSize: number

Property Value

Type Description
number

The font size.

format Property

Gets or sets the number or bullet format of the list level’s paragraphs.

Declaration

format: ListLevelFormat

Property Value

Type Description
ListLevelFormat

The list level format.

leftIndent Property

Gets or sets the left indent of the list level’s paragraphs.

Declaration

leftIndent: number

Property Value

Type Description
number

The left indent in twips.

separator Property

Gets or sets the character inserted between the list level’s number or bullet and paragraph text.

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 start position of the list level’s number.

Declaration

start: number

Property Value

Type Description
number

The start position.