PdfTextBoxField

12 Sep 20254 minutes to read

PdfTextBoxField class represents the text box field objects.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Access text box field
let field: PdfTextBoxField = document.form.fieldAt(0) as PdfTextBoxField;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

Properties

backColor number[]

Gets the background color of the field.

border PdfInteractiveBorder

Gets the width, style and dash of the border of the field.

borderColor number[]

Gets the border color of the field.

bounds Object

Gets the bounds.

color number[]

Gets the fore color of the field.

defaultValue string

Gets the default value of the field.

export boolean

Gets a value indicating whether the field is allow to export data or not.

flatten boolean

Gets the boolean flag indicating whether the form field have been flattened or not.

font PdfFont

Gets the font of the field.

form PdfForm

Gets the form object of the field (Read only).

highlightMode PdfHighlightMode

Gets the highlight mode of the field.

insertSpaces boolean

Meaningful only if the MaxLength property is set and the Multiline, Password properties are false.
If set, the field is automatically divided into as many equally spaced positions, or combs,
as the value of MaxLength, and the text is laid out into those combs.

isAutoResizeText boolean

Gets the flag indicating whether the auto resize text enabled or not.
Note: Applicable only for newly created PDF fields.

itemsCount number

Gets the count of the loaded field items (Read only).

mappingName string

Gets the mapping name to be used when exporting interactive form field data from the document.

maxLength number

Gets the maximum length of the field, in characters.

multiLine boolean

Gets a value indicating whether this PdfTextBoxField is multiline.

name string

Gets the name of the field (Read only).

page PdfPage

Gets the page object of the form field (Read only).

password boolean

Gets a value indicating whether this PdfTextBoxField is password.

readOnly boolean

Gets a value indicating whether read only.

required boolean

Gets a value indicating whether the field is required.

rotate number

Gets the rotation angle of the field.

rotationAngle PdfRotationAngle

Gets the rotation of the field (Read only).

scrollable boolean

Gets a value indicating whether this PdfTextBoxField is scrollable.

spellCheck boolean

Gets a value indicating whether to check spelling.

tabIndex number

Gets the tab index of annotation in current page.

text string

Gets the value of the text box field.

textAlignment PdfTextAlignment

Gets the text alignment in a text box.

toolTip string

Gets the tool tip of the form field.

visibility PdfFormFieldVisibility

Gets the form field visibility.

visible boolean

Gets a value indicating the visibility of the field (Read only).

Methods

getValue

Gets the value associated with the specified key.

Parameter	Type	Description
name	string	Key.

Returns string

itemAt

Gets the field item as PdfWidgetAnnotation at the specified index.

Parameter	Type	Description
index	number	Item index.

Returns PdfWidgetAnnotation

removeItem

Remove the specified form field item.

Parameter	Type	Description
item	PdfWidgetAnnotation	Item to remove.

Returns void

removeItemAt

Remove the form field item from the specified index.

Parameter	Type	Description
index	number	Item index to remove.

Returns void

setAppearance

Sets the flag to indicate the new appearance creation.

Parameter	Type	Description
value	boolean	Set appearance.

Returns void

setValue

Sets the value associated with the specified key.

Parameter	Type	Description
name	string	Key.
value	string	Value associated with the key..

Returns void