DS Server

ListFormat Object

Object|Introduced in 28.0

Description

The ListFormat object defines the formatting attributes of a bulleted or numbered list.

Syntax

ListFormat

Examples

The following example demonstrates ListFormat in a practical document-editing workflow. The ListFormat object defines the formatting attributes of a bulleted or numbered list.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

TXTextControl.listFormat.getBulletCharacter(
    function(result) {
        console.log("get bullet character result:", result);
    },
    onTxError
);

Members

Methods

Method	Description
getBulletCharacter	Gets the symbol character for a bulleted list.
getBulletSize	Gets the size of the symbol character for a bulleted list.
getFirstNumber	Gets the starting number for a numbered list.
getFontName	Gets the font used for the bullet character.
getFormatCharacter	Gets the formatting character for a bulleted or numbered list.
getHangingIndent	Gets the hanging indent of a numbered list.
getLeftIndent	Gets the left indent for a numbered list.
getLevel	Gets the level for a bulleted or numbered list.
getNumberFormat	Gets the number format for a numbered list.
getRestartNumbering	Gets a value determining whether a new numbered list begins.
getTextAfterNumber	Gets the text that is displayed behind the number in a numbered list.
getTextBeforeNumber	Gets the text that is displayed in front of the number in a numbered list.
getType	Gets the type of the list, bulleted, numbered or none.
setBulletCharacter	Sets the symbol character for a bulleted list.
setBulletSize	Sets the size of the symbol character for a bulleted list.
setFirstNumber	Sets the starting number for a numbered list.
setFontName	Sets the font used for the bullet character.
setFormatCharacter	Sets the formatting character for a bulleted or numbered list.
setHangingIndent	Sets the hanging indent of a numbered list.
setLeftIndent	Sets the left indent for a numbered list.
setLevel	Sets the level for a bulleted or numbered list.
setNumberFormat	Sets the number format for a numbered list.
setRestartNumbering	Sets the value determining whether a new numbered list begins.
setTextAfterNumber	Sets the text that is displayed behind the number in a numbered list.
setTextBeforeNumber	Sets the text that is displayed in front of the number in a numbered list.
setType	Sets the type of the list, bulleted, numbered or none.

Enumerations

Enumeration	Description
Attribute	Determines a certain list format attribute.