WidgetAnnotation

@scaryterry/pdfium

Defined in: src/core/types.ts:1325

Form widget annotation with field information.

Extends

ExtendedAnnotation

Properties

alternateName?

optional alternateName: string

Defined in: src/core/types.ts:1331

Alternate (tooltip) name.

author?

optional author: string

Defined in: src/core/types.ts:1315

Author/title if available.

Inherited from

ExtendedAnnotation.author

bounds

readonly bounds: Rect

Defined in: src/core/types.ts:507

The bounding rectangle in page coordinates.

Inherited from

ExtendedAnnotation.bounds

colour

readonly colour: Colour | null

Defined in: src/core/types.ts:509

The annotation colour, or null if not set.

Inherited from

ExtendedAnnotation.colour

contents?

optional contents: string

Defined in: src/core/types.ts:1313

Contents/subject text if available.

Inherited from

ExtendedAnnotation.contents

creationDate?

optional creationDate: string

Defined in: src/core/types.ts:1319

Creation date if available.

Inherited from

ExtendedAnnotation.creationDate

fieldFlags

fieldFlags: FormFieldFlags

Defined in: src/core/types.ts:1335

Form field flags.

fieldName?

optional fieldName: string

Defined in: src/core/types.ts:1329

Form field name.

fieldType

fieldType: FormFieldType

Defined in: src/core/types.ts:1327

Form field type.

fieldValue?

optional fieldValue: string

Defined in: src/core/types.ts:1333

Current field value.

flags

flags: AnnotationFlags

Defined in: src/core/types.ts:1311

Annotation flags.

Inherited from

ExtendedAnnotation.flags

index

readonly index: number

Defined in: src/core/types.ts:503

Zero-based index of the annotation on its page.

Inherited from

ExtendedAnnotation.index

modificationDate?

optional modificationDate: string

Defined in: src/core/types.ts:1317

Modification date if available.

Inherited from

ExtendedAnnotation.modificationDate

options?

optional options: WidgetOption[]

Defined in: src/core/types.ts:1337

Options for combo/list boxes.

type

readonly type: AnnotationType

Defined in: src/core/types.ts:505

The annotation subtype.

Inherited from

ExtendedAnnotation.type