PdfField API in JavaScript PDF API control

PdfField class represents the base class for form field objects.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data, password);
// Access the form field at index 0
let field: PdfField = document.form.fieldAt(0);
// Gets the count of the loaded field items
let count: number = field.itemsCount;
// 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.

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.

form PdfForm

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

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.

name string

Gets the name of the field (Read only).

page PdfPage

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

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

tabIndex number

Gets the tab index of annotation in current page.

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.

Returns string

itemAt

Gets the field item as PdfWidgetAnnotation at the specified index.

Returns PdfWidgetAnnotation

removeItem

Remove the specified form field item.

Returns void

removeItemAt

Remove the form field item from the specified index.

Returns void

setAppearance

Sets the flag to indicate the new appearance creation.

Returns void

setValue

Sets the value associated with the specified key.

Returns void