DS Server

Javascript: TXTextControl.removeTextField Method

MethodDeprecated|Introduced in 25.0

Description

Obsolete. This method will be removed in one of the next versions. The removeTextField method removes a text field from the document.

Syntax

<void> TXTextControl.removeTextField(<TextField> textField, <boolean> keepText)

Parameters

ParameterDescription
textField

The text field to remove from the document. Allowed types are TextField and ApplicationField. Must have been retrieved with getTextFields beforehand.

keepText

If this parameter is set to true, the field is removed without deleting its visible text. Otherwise, the field's text is also deleted.

Examples

The following example demonstrates TXTextControl.removeTextField in a practical document-editing workflow. Obsolete. This method will be removed in one of the next versions. The removeTextField method removes a text field from the document.

function removeTextField(textField) {
    TXTextControl.removeTextField(textField, true);
}