Javascript: CommentedText.setID Method

Description

Sets an identifier for the comment.

Syntax

<void> CommentedText.setID(<number> 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.setID in a practical document-editing workflow. It sets an identifier for the comment.

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.setID(
            1,
            function() {
                console.log("set id completed.");
            },
            onTxError
        );
    }, onTxError);
}, onTxError);