DS Server

Javascript: EditableRegion.setID Method

Method|Introduced in 28.0

Description

Sets an identifier for the editable region.

Syntax

<void> EditableRegion.setID(<number> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
value

The property value.

callback

Optional. Is called when the operation completed.

errorCallback

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

Examples

The following example demonstrates EditableRegion.setID in a practical document-editing workflow. It sets an identifier for the editable region.

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

function configureID(editableRegion) {
    editableRegion.setID(
        1,
        function() {
            console.log("set id completed.");
        },
        onTxError
    );
}