Javascript: Paragraph.getListNumber Method

Description

Gets the paragraph's list number.

Syntax

<void> Paragraph.getListNumber(<RequestNumberCallback> callback, [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
callback	Receives the paragraph's list number.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates Paragraph.getListNumber in a practical document-editing workflow. It gets the paragraph's list number.

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

TXTextControl.textParts.getMainText(function(mainText) {
    const paragraphs = mainText.paragraphs;
    paragraphs.getItem(function(paragraph) {
        if (!paragraph) {
            console.warn("No paragraph is available at the current input position.");
            return;
        }
    
        paragraph.getListNumber(
            function(result) {
                console.log("get list number result:", result);
            },
            onTxError
        );
    }, onTxError);
}, onTxError);