DS Server

Javascript: SignatureFieldCollection.remove Method

Method|Introduced in 31.0

Description

Removes a signature field from a Text Control document.

Syntax

<void> SignatureFieldCollection.remove(<SignatureField> field, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
field

Specifies the signature field to remove.

callback

Optional. Is called when the operation completed.

errorCallback

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

Examples

The following example demonstrates SignatureFieldCollection.remove in a practical document-editing workflow. It removes a signature field from a Text Control document.

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

function remove(field) {
    TXTextControl.signatureFields.remove(
        field,
        function() {
            console.log("remove completed.");
        },
        onTxError
    );
}