Description

Gets the first character position (one-based) of a document target.

Syntax

<void> DocumentTarget.getStart(<RequestNumberCallback> callback, [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
callback	Receives the position of the first character of the document target.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates DocumentTarget.getStart in a practical document-editing workflow. It gets the first character position (one-based) of a document target.

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

TXTextControl.textParts.getMainText(function(mainText) {
    const documentTargets = mainText.documentTargets;
    documentTargets.getItem(function(documentTarget) {
        if (!documentTarget) {
            console.warn("No document target is available at the current input position.");
            return;
        }
    
        documentTarget.getStart(
            function(result) {
                console.log("get start result:", result);
            },
            onTxError
        );
    }, onTxError);
}, onTxError);