Javascript: SubTextPart.scrollTo Method

Description

Sets the current input position to the beginning of a subtextpart and scrolls it into the visible part of the document.

Syntax

<void> SubTextPart.scrollTo(<RequestBooleanCallback> callback, [<ErrorCallback> errorCallback])

Parameters

Examples

The following example demonstrates SubTextPart.scrollTo in a practical document-editing workflow. It sets the current input position to the beginning of a subtextpart and scrolls it into the visible part of the document.

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 is available at the current input position.");
            return;
        }
    
        subTextPart.scrollTo(
            function(result) {
                if (result) {
                    console.log("scroll to is available.");
                } else {
                    console.warn("scroll to is not available in the current document state.");
                }
            },
            onTxError
        );
    }, onTxError);
}, onTxError);