Class: CheckBoxWidget
Experimental
A checkbox widget annotation
Extends
Constructors
Constructor
new CheckBoxWidget(
options):CheckBoxWidget
Experimental
Creates a new WidgetAnnotation instance.
Parameters
options
Options used to initialize annotation.
Returns
CheckBoxWidget
Inherited from
Properties
action
action:
Action
Experimental
The action that is performed when the widget annotation is clicked on
Inherited from
Accessors
boundingBox
Get Signature
get boundingBox():
Rectangle<PdfPoint>
Experimental
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
Experimental
Parameters
rectangle
Rectangle<PdfPoint>
Returns
void
Inherited from
content
Get Signature
get content():
string
Experimental
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
Experimental
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
Experimental
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
Experimental
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
Experimental
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
Experimental
Specifies whether the annotation allows user interaction.
Returns
boolean
Set Signature
set interactive(
interactive):void
Experimental
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
Experimental
Indicates if the annotation is maintaining its aspect ratio
Returns
boolean
Inherited from
WidgetAnnotation.isMaintainingAspectRatio
isMarkupAnnotation
Get Signature
get isMarkupAnnotation():
boolean
Experimental
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
Experimental
Indicates if the annotation can be moved by the user
Returns
boolean
Inherited from
isResizable
Get Signature
get isResizable():
boolean
Experimental
Indicates if the annotation can be resized by the user
Returns
boolean
Inherited from
isRotatable
Get Signature
get isRotatable():
boolean
Experimental
Indicates if the annotation can be rotated by the user
Returns
boolean
Inherited from
isSelectable
Get Signature
get isSelectable():
boolean
Experimental
Indicates if the annotation can be selected by the user
Returns
boolean
Inherited from
isWidgetAnnotation
Get Signature
get isWidgetAnnotation():
boolean
Experimental
Indicates if the annotation is a widget annotation
Returns
boolean
Inherited from
WidgetAnnotation.isWidgetAnnotation
locked
Get Signature
get locked():
AnnotationLockedState
Experimental
Represents the locked state of the annotation.
Returns
Set Signature
set locked(
locked):void
Experimental
Parameters
locked
Returns
void
Inherited from
page
Get Signature
get page():
Page
Experimental
Page in which the annotation is embedded.
Returns
Set Signature
set page(
page):void
Experimental
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():
object
Experimental
Custom data to be stored with the annotation
Returns
object
Set Signature
set privateData(
privateData):void
Experimental
Parameters
privateData
object
Returns
void
Inherited from
renderProperties
Get Signature
get renderProperties():
AnnotationRenderProperties
Experimental
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
Experimental
Parameters
v
Returns
void
Inherited from
WidgetAnnotation.renderProperties
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
Experimental
The PDF annotation type
Default Value
AnnotationType.Widget
Returns
Inherited from
Methods
dispose()
dispose():
void
Experimental
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