Description

Sets whether the comment is currently active or not.

Syntax

<void> CommentedText.setActive(<boolean> 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.setActive in a practical document-editing workflow. It sets whether the comment is currently active or not.

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.setActive(
            true,
            function() {
                console.log("set active completed.");
            },
            onTxError
        );
    }, onTxError);
}, onTxError);