Class: CheckBoxWidget
A checkbox widget annotation.
Extends
Constructors
Constructor
new CheckBoxWidget(
options):CheckBoxWidget
Creates a new CheckBoxWidget instance.
Parameters
options
Options used to initialize the checkbox widget.
Returns
CheckBoxWidget
Overrides
Properties
action
action:
Action
The action that is performed when the widget annotation is clicked on
Inherited from
Accessors
boundingBox
Get Signature
get boundingBox():
Rectangle<PdfPoint>
Represents the bounding box of the annotation, which defines its position and
size on the page. The bounding box is specified as a Rectangle of PdfPoint
coordinates.
Returns
Rectangle<PdfPoint>
Set Signature
set boundingBox(
rectangle):void
Parameters
rectangle
Rectangle<PdfPoint>
Returns
void
Inherited from
WatermarkAnnotation.boundingBox
checked
Get Signature
get checked():
boolean
The checked state of the checkbox.
Returns
boolean
Set Signature
set checked(
value):void
Parameters
value
boolean
Returns
void
content
Get Signature
get content():
string
Text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternative description of the annotation’s contents in human-readable form.
Returns
string
Set Signature
set content(
content):void
Parameters
content
string
Returns
void
Inherited from
dateModified
Get Signature
get dateModified():
Date
Experimental
The date and time when the annotation was most recently modified.
Returns
Date
Set Signature
set dateModified(
date):void
Parameters
date
Date
Returns
void
Inherited from
hasChanges
Get Signature
get hasChanges():
boolean
Experimental
Indicates if the annotation has been changed since the document was opened
Returns
boolean
Inherited from
hidden
Get Signature
get hidden():
boolean
If set to true, the annotation will not be displayed or printed, and it will not allow interaction with the user.
Returns
boolean
Set Signature
set hidden(
hidden):void
Parameters
hidden
boolean
Returns
void
Inherited from
id
Get Signature
get id():
void
Experimental
A unique identifier for the annotation.
Returns
void
Inherited from
interactive
Get Signature
get interactive():
boolean
Specifies whether the annotation allows user interaction.
Returns
boolean
Set Signature
set interactive(
interactive):void
Parameters
interactive
boolean
Returns
void
Inherited from
isAdded
Get Signature
get isAdded():
boolean
Experimental
Indicates whether the annotation was added to a page
Returns
boolean
Inherited from
isMaintainingAspectRatio
Get Signature
get isMaintainingAspectRatio():
boolean
Indicates if the annotation is maintaining its aspect ratio
Returns
boolean
Inherited from
WidgetAnnotation.isMaintainingAspectRatio
isMarkupAnnotation
Get Signature
get isMarkupAnnotation():
boolean
Indicates if the annotation is a markup annotation
Returns
boolean
Inherited from
WidgetAnnotation.isMarkupAnnotation
isModified
Get Signature
get isModified():
boolean
Experimental
Indicates if the annotation has changes that have not yet been saved to the document
Returns
boolean
Inherited from
isMoveable
Get Signature
get isMoveable():
boolean
Indicates if the annotation can be moved by the user
Returns
boolean
Inherited from
isResizable
Get Signature
get isResizable():
boolean
Indicates if the annotation can be resized by the user
Returns
boolean
Inherited from
isRotatable
Get Signature
get isRotatable():
boolean
Indicates if the annotation can be rotated by the user
Returns
boolean
Inherited from
isSelectable
Get Signature
get isSelectable():
boolean
Indicates if the annotation can be selected by the user
Returns
boolean
Inherited from
isWidgetAnnotation
Get Signature
get isWidgetAnnotation():
boolean
Indicates if the annotation is a widget annotation
Returns
boolean
Inherited from
WidgetAnnotation.isWidgetAnnotation
locked
Get Signature
get locked():
AnnotationLockedState
Represents the locked state of the annotation.
Returns
Set Signature
set locked(
locked):void
Parameters
locked
Returns
void
Inherited from
page
Get Signature
get page():
Page
Page in which the annotation is embedded.
Returns
Set Signature
set page(
page):void
Set the page in which the annotation is embedded.
Parameters
page
The page to set as the annotation’s page.
Returns
void
Inherited from
pageNumber
Get Signature
get pageNumber():
number
Experimental
Number of the page in which the annotation is embedded.
Returns
number
Inherited from
privateData
Get Signature
get privateData():
string
Custom data to be stored with the annotation. This can be used to store any additional information relevant to the annotation that is not covered by the standard properties.
Returns
string
Set Signature
set privateData(
privateData):void
Parameters
privateData
string
Custom data to be stored with the annotation.
Returns
void
Inherited from
readOnly
Get Signature
get readOnly():
boolean
Whether the field is read-only and its value may not be changed.
Remarks
When true, attempting to update this annotation via
AnnotationManager.update() will cause the returned Promise to reject.
Returns
boolean
Inherited from
renderProperties
Get Signature
get renderProperties():
AnnotationRenderProperties
Object which encapsulates the rendering properties of a PDF annotation, providing a set of flags that control its visibility, interactivity, and other rendering behaviors.
Returns
Set Signature
set renderProperties(
v):void
Parameters
v
Returns
void
Inherited from
WidgetAnnotation.renderProperties
required
Get Signature
get required():
boolean
Whether the field is required to have a value.
Returns
boolean
Inherited from
source
Get Signature
get source():
void
Experimental
Tag that identifies the source the annotation is coming from, if the source is
an input PDF or an input FDF. Newly created annotations always return null.
Returns
void
Inherited from
type
Get Signature
get type():
AnnotationType
The PDF annotation type
Default Value
AnnotationType.CheckBox
Returns
Overrides
Methods
dispose()
dispose():
void
Disposes of the object, releasing any resources it holds.
The dispose method is responsible for performing cleanup operations and
releasing any resources acquired by the object. Once an object is disposed, it
should not be used, and attempts to do so may result in undefined behavior.
Returns
void