Javascript: CommentedText.setComment Method

Description

Sets the comment text.

Syntax

<void> CommentedText.setComment(<string> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
value	The property value.
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.setComment in a practical document-editing workflow. It sets the comment text.

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.setComment(
            "Quarterly report",
            function() {
                console.log("set comment completed.");
            },
            onTxError
        );
    }, onTxError);
}, onTxError);