CommentedText Object

Description

A CommentedText object represents a commented piece of text. A comment can be inserted through the context menu or programmatically.

Syntax

CommentedText

Examples

The following example demonstrates CommentedText in a practical document-editing workflow. A CommentedText object represents a commented piece of text. A comment can be inserted through the context menu or programmatically.

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.getID(
            function(result) {
                console.log("get id result:", result);
            },
            onTxError
        );
    }, onTxError);
}, onTxError);

Members

Methods