Abstract Interface: Annotation
Base class for all annotations.
Extended by
Implements
Accessors
boundingBox
Get Signature
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
Set Signature
set boundingBox(
rectangle):void
Parameters
rectangle
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
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
hasChanges
Get Signature
get hasChanges():
boolean
Experimental
Indicates if the annotation has been changed since the document was opened
Returns
boolean
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
id
Get Signature
get id():
void
Experimental
A unique identifier for the annotation.
Returns
void
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
isAdded
Get Signature
get isAdded():
boolean
Experimental
Indicates whether the annotation was added to a page
Returns
boolean
isMaintainingAspectRatio
Get Signature
get
abstractisMaintainingAspectRatio():boolean
Indicates if the annotation is maintaining its aspect ratio
Returns
boolean
isMarkupAnnotation
Get Signature
get
abstractisMarkupAnnotation():boolean
Indicates if the annotation is a markup annotation
Returns
boolean
isModified
Get Signature
get isModified():
boolean
Experimental
Indicates if the annotation has changes that have not yet been saved to the document
Returns
boolean
isMoveable
Get Signature
get
abstractisMoveable():boolean
Indicates if the annotation can be moved by the user
Returns
boolean
isResizable
Get Signature
get
abstractisResizable():boolean
Indicates if the annotation can be resized by the user
Returns
boolean
isRotatable
Get Signature
get
abstractisRotatable():boolean
Indicates if the annotation can be rotated by the user
Returns
boolean
isSelectable
Get Signature
get
abstractisSelectable():boolean
Indicates if the annotation can be selected by the user
Returns
boolean
isWidgetAnnotation
Get Signature
get
abstractisWidgetAnnotation():boolean
Indicates if the annotation is a widget annotation
Returns
boolean
locked
Get Signature
get locked():
AnnotationLockedState
Represents the locked state of the annotation.
Returns
Set Signature
set locked(
locked):void
Parameters
locked
Returns
void
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
pageNumber
Get Signature
get pageNumber():
number
Experimental
Number of the page in which the annotation is embedded.
Returns
number
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
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
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
type
Get Signature
get
abstracttype():AnnotationType
The PDF annotation type
Returns
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
Implementation of
Disposable.dispose