PdfCheckBoxField
12 Sep 20254 minutes to read
PdfCheckBoxField class represents the check box 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 check box field
let field: PdfCheckBoxField = new PdfCheckBoxField('CheckBox1', {x: 100, y: 40, width: 20, height: 20}, page);
// Sets the checked flag as true.
field.checked = true;
// Sets the tool tip value
field.toolTip = 'Checked';
// Add the field into PDF form
form.add(field);
// 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.
checked boolean
Gets the flag indicating whether the field is checked or not.
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.
exportValue string
Gets the export value of the check box field.
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).
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.
textAlignment PdfTextAlignment
Gets the text alignment in a check box field.
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 item at the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number |
Index of the field item. |
Returns PdfStateItem
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