Skip to main content
Version: Version 5

Interface: CheckBoxWidgetOptions

Options for creating a CheckBoxWidget.

Extends​

Properties​

boundingBox?​

optional boundingBox?: Rectangle<PdfPoint>

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.

Default Value​

null

Inherited from​

WidgetAnnotationOptions.boundingBox

checked?​

optional checked?: boolean

The initial checked state of the checkbox.

Remarks​

Currently, the Web SDK does not support creating widget annotations. This option is not applied when adding a new CheckBoxWidget:

const checkbox = new CheckBoxWidget({ page, boundingBox, checked: true });
await annotationManager.add(checkbox); // Fails since widget creation is not supported

Widget annotations can only be loaded from existing PDFs and then modified.

Default Value​

false

content?​

optional 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.

Default Value​

""

Inherited from​

WidgetAnnotationOptions.content

dateModified?​

optional dateModified?: Date

The date and time when the annotation was most recently modified.

Inherited from​

WidgetAnnotationOptions.dateModified

page​

page: Page

Page in which the annotation is embedded.

Inherited from​

WidgetAnnotationOptions.page

privateData?​

optional 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.

Default Value​

undefined

Inherited from​

WidgetAnnotationOptions.privateData

renderProperties?​

optional renderProperties?: AnnotationRenderProperties

The AnnotationRenderProperties class encapsulates the rendering properties of a PDF annotation, providing a set of flags that control its rendering behaviors.

Inherited from​

WidgetAnnotationOptions.renderProperties