Javascript: LineCollection.getItem Method

Description

Gets a particular line from the collection.

Syntax

<void> LineCollection.getItem(<RequestLineCallback> callback, <number> textPosition, [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
callback	Receives the particular line.
textPosition	Specifies a zero-based text position.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates LineCollection.getItem in a practical document-editing workflow. It gets a particular line from the collection.

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

function inspectItem(lines) {
    lines.getItem(
        function(result) {
            if (!result) {
                console.warn("No line was returned.");
                return;
            }
            
            console.log("get item result:", result);
        },
        -1,
        onTxError
    );
}