Javascript: CommentedText.scrollTo Method

Description

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

Syntax

<void> CommentedText.scrollTo([<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
callback	Optional. Is called when the operation completed.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates CommentedText.scrollTo in a practical document-editing workflow. It sets the current input position to the beginning of a comment 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 comments = mainText.comments;
    comments.getItem(function(commentedText) {
        if (!commentedText) {
            console.warn("No commented text is available at the current input position.");
            return;
        }
    
        commentedText.scrollTo(
            function() {
                console.log("scroll to completed.");
            },
            onTxError
        );
    }, onTxError);
}, onTxError);