Javascript: SubTextPartCollection.getItem Method

Description

Gets the subtextpart at the current text input position.

Syntax

<void> SubTextPartCollection.getItem(<RequestSubTextPartCallback> callback, [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
callback	Receives the found subtextpart.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates SubTextPartCollection.getItem in a practical document-editing workflow. It gets the subtextpart at the current text input position.

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

TXTextControl.textParts.getMainText(function(mainText) {
    const subTextParts = mainText.subTextParts;
    subTextParts.getItem(
        function(subTextPart) {
            if (!subTextPart) {
                console.warn("No sub text part was returned.");
                return;
            }
            
            console.log("get item result:", subTextPart);
        },
        onTxError
    );
}, onTxError);