Description

Gets a value specifying whether the TrackedChange is currently active or not.

Syntax

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

Parameters

Parameter	Description
callback	Receives whether the TrackedChange is currently active or not.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates TrackedChange.getActive in a practical document-editing workflow. It gets a value specifying whether the TrackedChange 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 trackedChanges = mainText.trackedChanges;
    trackedChanges.getItem(function(trackedChange) {
        if (!trackedChange) {
            console.warn("No tracked change is available at the current input position.");
            return;
        }
    
        trackedChange.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);