TXTextControl.FormTextFieldInsert Method

This method inserts a text input field for a form into the document at the current text input position. If such a field is empty, it can be set to a specified width so that the end-user can see where to enter text.

Introduced: 28.0.

Syntax

TXTextControl.FormTextFieldInsert FieldText [, EmptyWidth]
Parameter Description
FieldText

Specifies the text contents for the new field.

EmptyWidth

Optional. Specifies the field's width, in twips, when it is empty. If this parameter is omitted, a default width of 2000 twips is used.

Return Value

The method returns True if the text formfield could be inserted, otherwise it returns False.

Remarks

Inserting a form field changes the value of the FieldCurrent property to the identifier of the newly created field.

Data Types

FieldText: String
EmptyWidth: Integer

See Also