Description

Gets whether the comment is currently active or not.

Syntax

<void> CommentedText.getActive(<RequestBooleanCallback> callback, [<ErrorCallback> errorCallback])

Parameters

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

Examples

The following example demonstrates CommentedText.getActive in a practical document-editing workflow. It gets 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.getActive(
            function(result) {
                if (result) {
                    console.log("get active is available.");
                } else {
                    console.warn("get active is not available in the current document state.");
                }
            },
            onTxError
        );
    }, onTxError);
}, onTxError);