DsPdfJS API v9.1.0

DsPdfJS API / AnnotationBaseProperties

Type Alias: AnnotationBaseProperties

AnnotationBaseProperties = object

Defines common properties for all annotations.

See

AnnotationBase

Properties

contents?

optional contents: string

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.

flags?

optional flags: AnnotationFlags

The flags specifying various characteristics of the annotation.

locked?

optional locked: boolean

The 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. Not specified means false.

lockedContents?

optional 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. Not specified means false.

modifiedDate?

optional modifiedDate: PdfDateTime

The date and time when the annotation was modified.

name?

optional name: string

The annotation name, a text string uniquely identifying it among all annotations on its page.

page?

optional page: PdfPage

The PdfPage that contains this annotation.

rect?

optional rect: Rect

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.