PdfTextBoxField

6 Feb 202615 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

Get backColor PdfColor

Gets the background color of the field.

Set backColor void

Sets the background color of the field.

Parameter	Type	Description
value	PdfColor	Array with R, G, B, A color values in between 0 to 255.

Get border PdfInteractiveBorder

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

Set border void

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

Parameter	Type	Description
value	PdfInteractiveBorder	Border properties.

Get borderColor PdfColor

Gets the border color of the field.

Set borderColor void

Sets the border color of the field.

Parameter	Type	Description
value	PdfColor	Array with R, G, B, A color values in between 0 to 255.

Get bounds Rectangle

Gets the bounds.

Set bounds void

Sets the bounds.

Parameter	Type	Description
value	Rectangle	Bounds.

Get color PdfColor

Gets the fore color of the field.

Set color void

Sets the fore color of the field.

Parameter	Type	Description
value	PdfColor	R, G, B color values in between 0 to 255.

Get defaultValue string

Gets the default value of the field.

Set defaultValue void

Sets the default value of the field.

Parameter	Type	Description
value	string	Default value.

Get export boolean

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

Set export void

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

Parameter	Type	Description
value	boolean	Allow to export data or not.

Get flatten boolean

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

Set flatten void

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

Parameter	Type	Description
value	boolean	Flatten.

Get font PdfFont

Gets the font of the field.

Set font void

Sets the font of the field.

Parameter	Type	Description
value	PdfFont	Font.

Get form PdfForm

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

Get highlightMode PdfHighlightMode

Gets the highlight mode of the field.

Set highlightMode void

Sets the highlight mode of the field.

Parameter	Type	Description
value	PdfHighlightMode	Highlight mode.

Get 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.

Set insertSpaces void

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.

Parameter	Type	Description
value	boolean	InsertSpaces.

Get isAutoResizeText boolean

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

Set isAutoResizeText void

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

Parameter	Type	Description
value	boolean	Enable or disable auto resize text.

Get itemsCount number

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

Get mappingName string

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

Set mappingName void

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

Parameter	Type	Description
value	string	Mapping name.

Get maxLength number

Gets the maximum length of the field, in characters.

Set maxLength void

Sets the maximum length of the field, in characters.

Parameter	Type	Description
value	number	Maximum length.

Get multiLine boolean

Gets a value indicating whether this PdfTextBoxField is multiline.

Set multiLine void

Sets a value indicating whether this PdfTextBoxField is multiline.

Parameter	Type	Description
value	boolean	MultiLine or not.

Get name string

Gets the name of the field (Read only).

Get page PdfPage

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

Get password boolean

Gets a value indicating whether this PdfTextBoxField is password.

Set password void

Sets a value indicating whether this PdfTextBoxField is password.

Parameter	Type	Description
value	boolean	Password or not.

Get readOnly boolean

Gets a value indicating whether read only.

Set readOnly void

Sets a value indicating whether read only.

Parameter	Type	Description
value	boolean	Read only or not.

Get required boolean

Gets a value indicating whether the field is required.

Set required void

Sets a value indicating whether the field is required.

Parameter	Type	Description
value	boolean	Required or not.

Get rotate number

Gets the rotation angle of the field.

Set rotate void

Sets the rotation angle of the field.

Parameter	Type	Description
value	number	Rotation angle.

Get rotationAngle PdfRotationAngle

Gets the rotation of the field (Read only).

Get scrollable boolean

Gets a value indicating whether this PdfTextBoxField is scrollable.

Set scrollable void

Sets a value indicating whether this PdfTextBoxField is scrollable.

Parameter	Type	Description
value	boolean	Scrollable or not.

Get spellCheck boolean

Gets a value indicating whether to check spelling.

Set spellCheck void

Sets a value indicating whether to check spelling.

Parameter	Type	Description
value	boolean	SpellCheck or not.

Get tabIndex number

Gets the tab index of annotation in current page.

Set tabIndex void

Sets the tab index of a annotation in the current page.

Parameter	Type	Description
value	number	Index.

Get text string

Gets the value of the text box field.

Set text void

Sets the value of the text box field.

Parameter	Type	Description
value	string	Text.

Get textAlignment PdfTextAlignment

Gets the text alignment in a text box.

Set textAlignment void

Sets the text alignment in a text box.

Parameter	Type	Description
value	PdfTextAlignment	Text alignment.

Get toolTip string

Gets the tool tip of the form field.

Set toolTip void

Sets the tool tip of the form field.

Parameter	Type	Description
value	string	Tooltip.

Get visibility PdfFormFieldVisibility

Gets the form field visibility.

Set visibility void

Sets the form field visibility.

Parameter	Type	Description
value	PdfFormFieldVisibility	Visibility.

Get visible boolean

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

Set visible void

Sets a value indicating the visibility of the field.
Only applicable for newly created PDF form fields.

Parameter	Type	Description
value	boolean	Or not.

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