- README
- globals
-
classes
- AcroForm
- ActionBase
- ActionFieldsBase
- ActionGoTo
- ActionGoToR
- ActionJavaScript
- ActionJavaScriptMap
- ActionNamed
- ActionResetForm
- ActionSubmitForm
- ActionUnknown
- ActionURI
- AnnotationBase
- AnnotationCollection
- AnnotationPagesCollection
- BilevelBitmap
- Bitmap
- BmpContext
- Border
- BorderEffect
- Brush
- ButtonAppearance
- CaretAnnotation
- CheckBoxField
- ChoiceField
- CircleAnnotation
- ComboBoxField
- CombTextField
- DefaultAppearance
- Destination
- DestinationBase
- DestinationFit
- DestinationFitB
- DestinationFitBH
- DestinationFitBV
- DestinationFitH
- DestinationFitR
- DestinationFitV
- DestinationRef
- DestinationUnknown
- DestinationXYZ
- DocAction
- DocumentDestinations
- DocumentInfo
- DrawingContext
- DsPdf
- DsPdfConfig
- EmbeddedFileStream
- Field
- FieldCollection
- FieldWidgetCollection
- FileAttachmentAnnotation
- FileSpecification
- FileSpecificationMap
- Font
- FontCollection
- FontHandler
- FontHandlerCollection
- Format
- FreeTextAnnotation
- GraphicsPath
- GrayscaleBitmap
- HatchBrush
- Image
- ImageBrush
- InkAnnotation
- Layout
- LineAnnotation
- LinearGradientBrush
- LinkAnnotation
- ListBoxField
- MarkupAnnotation
- Metadata
- ObjectBase
- ObjectManager
- OutlineNode
- OutlineNodeCollection
- PdfContext
- PdfDocument
- PdfImageHandler
- PdfImageHandlerCollection
- PdfPage
- PdfPageCollection
- Pen
- PolygonAnnotation
- PolygonAnnotationBase
- PolyLineAnnotation
- PopupAnnotation
- PushButtonField
- RadialGradientBrush
- RadioButtonField
- RedactAnnotation
- RichMediaAnnotation
- Security
- SecurityHandlerBase
- SignatureField
- SolidBrush
- SoundAnnotation
- SoundObject
- SplitOptions
- SquareAnnotation
- StampAnnotation
- StandardSecurityHandler
- StandardSecurityHandlerRev2
- StandardSecurityHandlerRev3
- StandardSecurityHandlerRev4
- StandardSecurityHandlerRev5
- StandardSecurityHandlerRev6
- SvgContext
- SvgDocument
- TextAnnotation
- TextField
- TextMarkupAnnotation
- Transform
- UnknownAnnotation
- UnknownSecurityHandler
- WatermarkAnnotation
- WidgetAnnotation
- enumerations
- functions
- type-aliases
TextAnnotation
DsPdfJS API / TextAnnotation
Class: TextAnnotation
Represents a sticky note attached to a point in a PDF document.
Extends
Constructors
Constructor
new TextAnnotation(
om):TextAnnotation
Creates a new TextAnnotation.
Parameters
om
ObjectManager that controls the lifetime of the TextAnnotation.
Returns
TextAnnotation
Overrides
MarkupAnnotation.constructor
Constructor
new TextAnnotation():
TextAnnotation
Creates a new TextAnnotation.
Returns
TextAnnotation
Overrides
MarkupAnnotation.constructor
Accessors
color
Get Signature
get color():
Color
Gets or sets the annotation color, it used as color of popup window, lines color etc.
Returns
Set Signature
set color(
value):void
Gets or sets the annotation color, it used as color of popup window, lines color etc.
Parameters
value
Returns
void
Inherited from
contents
Get Signature
get contents():
string|null
Gets or sets the text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form. In either case, this text is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes.
Returns
string | null
Set Signature
set contents(
value):void
Gets or sets the text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form. In either case, this text is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes.
Parameters
value
string | null
Returns
void
Inherited from
creationDate
Get Signature
get creationDate():
PdfDateTime|null
Gets or sets the date and time when the annotation was created.
Returns
PdfDateTime | null
Set Signature
set creationDate(
value):void
Gets or sets the date and time when the annotation was created.
Parameters
value
PdfDateTime | null
Returns
void
Inherited from
doc
Get Signature
get doc():
PdfDocument|null
Gets the PdfDocument owning this annotation.
Returns
PdfDocument | null
Inherited from
flags
Get Signature
get flags():
AnnotationFlags
Gets or sets the flags specifying various characteristics of the annotation.
Returns
Set Signature
set flags(
value):void
Gets or sets the flags specifying various characteristics of the annotation.
Parameters
value
Returns
void
Inherited from
icon
Get Signature
get icon():
string
Gets or sets the type of the icon used to display the annotation, possible values: "Note", "Comment", "Key", "Help", "NewParagraph", "Paragraph", "Insert".
Returns
string
Set Signature
set icon(
value):void
Gets or sets the type of the icon used to display the annotation, possible values: "Note", "Comment", "Key", "Help", "NewParagraph", "Paragraph", "Insert".
Parameters
value
Returns
void
id
Get Signature
get id():
number
Gets the reference to the object.
Returns
number
Inherited from
locked
Get Signature
get locked():
boolean
Gets or sets a value indicating whether the annotation can be deleted or its properties (including position and size) can be modified by the user. However, this flag does not restrict changes to the annotation's contents, such as the value of a form field.
Returns
boolean
Set Signature
set locked(
value):void
Gets or sets a value indicating whether the annotation can be deleted or its properties (including position and size) can be modified by the user. However, this flag does not restrict changes to the annotation's contents, such as the value of a form field.
Parameters
value
boolean
Returns
void
Inherited from
lockedContents
Get Signature
get lockedContents():
boolean
Gets or sets a value indicating whether the contents of the annotation can be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size.
Returns
boolean
Set Signature
set lockedContents(
value):void
Gets or sets a value indicating whether the contents of the annotation can be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size.
Parameters
value
boolean
Returns
void
Inherited from
MarkupAnnotation.lockedContents
modifiedDate
Get Signature
get modifiedDate():
PdfDateTime|null
Gets or sets the date and time when the annotation was modified.
Returns
PdfDateTime | null
Set Signature
set modifiedDate(
value):void
Gets or sets the date and time when the annotation was modified.
Parameters
value
PdfDateTime | null
Returns
void
Inherited from
name
Get Signature
get name():
string|null
Gets or sets the annotation name, a text string uniquely identifying it among all annotations on its page.
Returns
string | null
Set Signature
set name(
value):void
Gets or sets the annotation name, a text string uniquely identifying it among all annotations on its page.
Parameters
value
string | null
Returns
void
Inherited from
om
Get Signature
get om():
ObjectManager
Gets the owner ObjectManager instance.
Returns
Inherited from
opacity
Get Signature
get opacity():
number
Gets or sets the opacity value to be used in painting the annotation. This value applies to all visible elements of the annotation in its closed state (including its background and border) but not to the pop-up window that appears when the annotation is opened.
Returns
number
Set Signature
set opacity(
value):void
Gets or sets the opacity value to be used in painting the annotation. This value applies to all visible elements of the annotation in its closed state (including its background and border) but not to the pop-up window that appears when the annotation is opened.
Parameters
value
number
Returns
void
Inherited from
open
Get Signature
get open():
boolean
Gets or sets a flag specifying whether the annotation should initially be displayed open.
Returns
boolean
Set Signature
set open(
value):void
Gets or sets a flag specifying whether the annotation should initially be displayed open.
Parameters
value
boolean
Returns
void
page
Get Signature
get page():
PdfPage|null
Gets or sets the PdfPage that contains this annotation. Note that an annotation may be referenced by several pages. In that case this property returns the first element in the pages collection. When setting this property, the following applies: If the new value is null, this annotation is removed from all pages. Otherwise, this annotation is assigned exclusively to the specified page.
Returns
PdfPage | null
Set Signature
set page(
value):void
Gets or sets the PdfPage that contains this annotation. Note that an annotation may be referenced by several pages. In that case this property returns the first element in the pages collection. When setting this property, the following applies: If the new value is null, this annotation is removed from all pages. Otherwise, this annotation is assigned exclusively to the specified page.
Parameters
value
PdfPage | null
Returns
void
Inherited from
pages
Get Signature
get pages():
AnnotationPagesCollection
Gets the list of pages that reference this annotation.
Returns
Inherited from
pdfRect
Get Signature
get pdfRect():
Rect
Gets or sets the rectangle that defines the location and size of the annotation on a page in PDF user space coordinates. The positive X axis extends horizontally to the right, and the positive Y axis extends vertically upward, with the origin usually in the lower left corner of the page.
See
Returns
Set Signature
set pdfRect(
value):void
Gets or sets the rectangle that defines the location and size of the annotation on a page in PDF user space coordinates. The positive X axis extends horizontally to the right, and the positive Y axis extends vertically upward, with the origin usually in the lower left corner of the page.
See
Parameters
value
Returns
void
Inherited from
popup
Get Signature
get popup():
PopupAnnotation|null
Gets or sets the PopupAnnotation annotation for entering or editing text associated with this annotation. Setting this property changes the PopupAnnotation#parent property. A separate PopupAnnotation allows defining additional properties of the popup window: color, position etc.
Returns
PopupAnnotation | null
Set Signature
set popup(
value):void
Gets or sets the PopupAnnotation annotation for entering or editing text associated with this annotation. Setting this property changes the PopupAnnotation#parent property. A separate PopupAnnotation allows defining additional properties of the popup window: color, position etc.
Parameters
value
PopupAnnotation | null
Returns
void
Inherited from
rect
Get Signature
get rect():
Rect
Gets or sets the rectangle that defines the location and size of the annotation on a page. The coordinates of the rectangle are relative to the upper left corner of the page's media box, with the Y (vertical) coordinates increasing from top to bottom. Note that if the annotation is associated with more than one page, the media box of the first of those pages is used to calculate the rectangle's location.
Returns
Set Signature
set rect(
value):void
Gets or sets the rectangle that defines the location and size of the annotation on a page. The coordinates of the rectangle are relative to the upper left corner of the page's media box, with the Y (vertical) coordinates increasing from top to bottom. Note that if the annotation is associated with more than one page, the media box of the first of those pages is used to calculate the rectangle's location.
Parameters
value
Returns
void
Inherited from
referenceAnnotation
Get Signature
get referenceAnnotation():
MarkupAnnotation|null
Gets or sets the annotation referenced by this annotation.
Returns
MarkupAnnotation | null
Set Signature
set referenceAnnotation(
value):void
Gets or sets the annotation referenced by this annotation.
Parameters
value
MarkupAnnotation | null
Returns
void
Inherited from
MarkupAnnotation.referenceAnnotation
referenceType
Get Signature
get referenceType():
string
Gets or sets the relationship (reference type) between this annotation and the annotation specified by the 'referenceAnnotation' property. The referenced annotation should be on the same page with the current annotation. The valid values: "R" (reply), "Group"
Returns
string
Set Signature
set referenceType(
value):void
Gets or sets the relationship (reference type) between this annotation and the annotation specified by the 'referenceAnnotation' property. The referenced annotation should be on the same page with the current annotation. The valid values: "R" (reply), "Group"
Parameters
value
Returns
void
Inherited from
MarkupAnnotation.referenceType
richText
Get Signature
get richText():
string
Gets or sets the text to be displayed in the pop-up window when the annotation is opened. This text can be formatted using HTML tags, see PDF specification for details.
Returns
string
Set Signature
set richText(
value):void
Gets or sets the text to be displayed in the pop-up window when the annotation is opened. This text can be formatted using HTML tags, see PDF specification for details.
Parameters
value
string | null
Returns
void
Inherited from
state
Get Signature
get state():
string
Gets or sets the state to which the original annotation shall be set. The following describes the predefined combinations of State and StateModel, and their meanings:
- StateModel "Marked", State "Marked" The annotation has been marked by the user.
- StateModel "Marked", State "Unmarked" The annotation has not been marked by the user (the default).
- StateModel "Review", State "Accepted" The user agrees with the change.
- StateModel "Review", State "Rejected" The user disagrees with the change.
- StateModel "Review", State "Cancelled" The change has been cancelled.
- StateModel "Review", State "Completed" The change has been completed.
- StateModel "Review", State "None" The user has indicated nothing about the change (the default).
See PDF specification for more details.
Returns
string
Set Signature
set state(
value):void
Gets or sets the state to which the original annotation shall be set. The following describes the predefined combinations of State and StateModel, and their meanings:
- StateModel "Marked", State "Marked" The annotation has been marked by the user.
- StateModel "Marked", State "Unmarked" The annotation has not been marked by the user (the default).
- StateModel "Review", State "Accepted" The user agrees with the change.
- StateModel "Review", State "Rejected" The user disagrees with the change.
- StateModel "Review", State "Cancelled" The change has been cancelled.
- StateModel "Review", State "Completed" The change has been completed.
- StateModel "Review", State "None" The user has indicated nothing about the change (the default).
See PDF specification for more details.
Parameters
value
string
Returns
void
stateModel
Get Signature
get stateModel():
string
Gets or sets the state model corresponding to 'State'.
See 'State' and PDF specification for details.
Returns
string
Set Signature
set stateModel(
value):void
Gets or sets the state model corresponding to 'State'.
See 'State' and PDF specification for details.
Parameters
value
string
Returns
void
subject
Get Signature
get subject():
string|null
Gets or sets the text representing a short description of the subject being addressed by the annotation.
Returns
string | null
Set Signature
set subject(
value):void
Gets or sets the text representing a short description of the subject being addressed by the annotation.
Parameters
value
string | null
Returns
void
Inherited from
userName
Get Signature
get userName():
string|null
Gets or sets the text label to be displayed in the title bar of the annotation's pop-up window when open and active. By convention, this entry identifies the user who added the annotation.
Returns
string | null
Set Signature
set userName(
value):void
Gets or sets the text label to be displayed in the title bar of the annotation's pop-up window when open and active. By convention, this entry identifies the user who added the annotation.
Parameters
value
string | null
Returns
void
Inherited from
Methods
free()
free():
void
Detaches the object from the ObjectManager and deallocates its memory, if possible.
Returns
void
Inherited from
rebind()
rebind(
omTo):void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
omTo
The new ObjectManager for the object.
Returns
void
Inherited from
removeAppearance()
removeAppearance():
void
Removes all appearance streams associated with the current annotation, and disables generation of appearance steams for this annotation when the document is saved.
Note that if any property affecting the annotation's appearance 'rect' is then changed, the appearance streams will be regenerated. So this method would usually be called after initializing all annotation's properties.
Returns
void
Inherited from
MarkupAnnotation.removeAppearance
resetAppearance()
resetAppearance():
void
Forces regeneration of the annotation's appearance streams next time the document is saved.
Returns
void