DS Server

Javascript: TextField.setName Method

Method|Introduced in 28.0

Description

Sets the name of a text field.

Syntax

<void> TextField.setName(<string> name, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
name

Relates a user-defined name to a text field.

callback

Optional. Is called when the operation completed.

errorCallback

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

Examples

The following example demonstrates TextField.setName in a practical document-editing workflow. It sets the name of a text field.

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

function configureName(textField) {
    textField.setName(
        "InvoiceNumber",
        function() {
            console.log("set name completed.");
        },
        onTxError
    );
}