TrackedChange Object

Description

A TrackedChange object represents a change made to the document after anyone has revised the document. After tracking changes has been turned on with the setIsTrackChangesEnabled method, a TextControl marks up new changes made to the document. Every change is represented through a TrackedChange object, all of these objects are contained in the TrackedChangeCollection which can be obtained with the trackedChanges property.

Syntax

TrackedChange

Examples

The following example demonstrates TrackedChange in a practical document-editing workflow. A TrackedChange object represents a change made to the document after anyone has revised the document. After tracking changes has been turned on with the setIsTrackChangesEnabled method, a TextControl marks up new changes made to the document. Every change is represented through a TrackedChange object, all of these objects are contained in the TrackedChangeCollection which can be obtained with the trackedChanges property.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

TXTextControl.textParts.getMainText(function(mainText) {
    const trackedChanges = mainText.trackedChanges;
    trackedChanges.getItem(function(trackedChange) {
        if (!trackedChange) {
            console.warn("No tracked change is available at the current input position.");
            return;
        }
    
        trackedChange.getText(
            function(result) {
                console.log("get text result:", result);
            },
            onTxError
        );
    }, onTxError);
}, onTxError);

Members

Methods