DS Server

Javascript: EditableRegion.getStart Method

Method|Introduced in 28.0

Description

Gets the index (one-based) of the first character which belongs to the editable region.

Syntax

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

Parameters

ParameterDescription
callback

Receives the index (one-based) of the first character which belongs to the editable region.

errorCallback

Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates EditableRegion.getStart in a practical document-editing workflow. It gets the index (one-based) of the first character which belongs to the editable region.

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

function inspectStart(editableRegion) {
    editableRegion.getStart(
        function(result) {
            console.log("get start result:", result);
        },
        onTxError
    );
}