PdfSignatureField
16 Dec 20254 minutes to read
PdfSignatureField class represents the signature field objects.
// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Gets the first page of the document
let page: PdfPage = document.getPage(0);
// Access the PDF form
let form: PdfForm = document.form;
// Create a new signature field
let field: PdfSignatureField = new PdfSignatureField(page, 'Signature', {x: 10, y: 10, width: 100, height: 50});
// Add the field into PDF form
form.add(field);
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();Properties
backColor PdfColor
Gets the background color of the field.
border PdfInteractiveBorder
Gets the width, style and dash of the border of the field.
borderColor PdfColor
Gets the border color of the field.
bounds Rectangle
Gets the bounds.
color PdfColor
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).
isSigned boolean
Gets the flag to indicate whether the field is signed or not.
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
getAppearance
Gets the appearance of the PDF signature field.
Returns PdfAppearance
getRevision
Gets the revision index of the PDF signature field.
Returns number
getSignature
Gets the signature associated with the PDF signature field.
Returns PdfSignature
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
setSignature
Sets the signature for the PDF signature field.
| Parameter | Type | Description |
|---|---|---|
| signature | PdfSignature |
The signature to assign to the field. |
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