Class: TextBoxWidget
Experimental
A text box widget annotation
Extends
Constructors
new TextBoxWidget()
new TextBoxWidget(
options):TextBoxWidget
Experimental
Parameters
• options: WidgetAnnotationOptions
Options used to initialize annotation.
Returns
Inherited from
Properties
action
action:
Action
Experimental
The action that is performed when the widget annotation is clicked on
Inherited from
Accessors
__annotation
get__annotation():Annotation
Experimental
set__annotation(v):void
Experimental
Parameters
• v: Annotation
Returns
Annotation
Inherited from
boundingBox
getboundingBox():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.
setboundingBox(rectangle):void
Experimental
Parameters
• rectangle: Rectangle<PdfPoint>
Returns
Rectangle<PdfPoint>
Inherited from
content
getcontent():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.
setcontent(content):void
Experimental
Parameters
• content: string
Returns
string
Inherited from
dateModified
getdateModified():Date
Experimental
The date and time when the annotation was most recently modified.
setdateModified(date):void
Experimental
Parameters
• date: Date
Returns
Date
Inherited from
hasChanges
gethasChanges():boolean
Experimental
Indicates if the annotation has been changed since the document was opened
Returns
boolean
Inherited from
hidden
gethidden():boolean
Experimental
If set to true, the annotation will not be displayed or printed, and it will not allow interaction with the user.
sethidden(hidden):void
Experimental
Parameters
• hidden: boolean
Returns
boolean
Inherited from
id
getid():void
Experimental
A unique identifier for the annotation.
Returns
void
Inherited from
interactive
getinteractive():boolean
Experimental
Specifies whether the annotation allows user interaction.
setinteractive(interactive):void
Experimental
Parameters
• interactive: boolean
Returns
boolean
Inherited from
isAdded
getisAdded():boolean
Experimental
Indicates whether the annotation was added to a page
Returns
boolean
Inherited from
isMaintainingAspectRatio
getisMaintainingAspectRatio():boolean
Experimental
Indicates if the annotation is maintaining its aspect ratio
Returns
boolean
Inherited from
WidgetAnnotation.isMaintainingAspectRatio
isMarkupAnnotation
getisMarkupAnnotation():boolean
Experimental
Indicates if the annotation is a markup annotation
Returns
boolean
Inherited from
WidgetAnnotation.isMarkupAnnotation
isModified
getisModified():boolean
Experimental
Indicates if the annotation has changes that have not yet been saved to the document
Returns
boolean
Inherited from
isMoveable
getisMoveable():boolean
Experimental
Indicates if the annotation can be moved by the user
Returns
boolean
Inherited from
isResizable
getisResizable():boolean
Experimental
Indicates if the annotation can be resized by the user
Returns
boolean
Inherited from
isRotatable
getisRotatable():boolean
Experimental
Indicates if the annotation can be rotated by the user
Returns
boolean
Inherited from
isSelectable
getisSelectable():boolean
Experimental
Indicates if the annotation can be selected by the user
Returns
boolean
Inherited from
isWidgetAnnotation
getisWidgetAnnotation():boolean
Experimental
Indicates if the annotation is a widget annotation
Returns
boolean
Inherited from
WidgetAnnotation.isWidgetAnnotation
locked
getlocked():AnnotationLockedState
Experimental
Represents the locked state of the annotation.
setlocked(locked):void
Experimental
Parameters
• locked: AnnotationLockedState
Returns
Inherited from
page
getpage():Page
Experimental
Page in which the annotation is embedded.
setpage(page):void
Experimental
Set the page in which the annotation is embedded.
Parameters
• page: Page
The page to set as the annotation’s page.
Returns
Inherited from
pageNumber
getpageNumber():number
Experimental
Number of the page in which the annotation is embedded.
Returns
number
Inherited from
privateData
getprivateData():object
Experimental
Custom data to be stored with the annotation
setprivateData(privateData):void
Experimental
Parameters
• privateData: object
Returns
object
Inherited from
renderProperties
getrenderProperties():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.
setrenderProperties(v):void
Experimental
Parameters
• v: AnnotationRenderProperties
Returns
Inherited from
WidgetAnnotation.renderProperties
source
getsource():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
gettype():AnnotationType
Experimental
The PDF annotation type
Default Value
AnnotationType.Widget
Returns
Inherited from
Methods
dispose()
dispose():
void
Experimental
Returns
void