Class ButtonWidget

An alternate field text to be used as tooltip. This text is also useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes.

Annotation name (NM entry).

Annotation type.

Appearance color.

Annotation's border style.

Annotation color.

The text (or rich text) string that shall be displayed in the pop-up when the annotation is opened.

Indicates whether the annotation will be converted to content when the document is saved.

Creation date.

The field is used for compatibility with Adobe Acrobat Reader.

Field name.

Field type.

Field widget value.

Font name. Available standard font names: 'Helv' (Helvetica), 'HelveticaItalic' (Helvetica Italic), 'HelveticaBold' (Helvetica Bold), 'HelveticaBoldItalic' (Helvetica Bold Italic), 'TimesRegular' (Times Roman), 'TimesItalic' (Times Roman Italic), 'TimesBold' (Times Roman Bold), 'TimesBoldItalic' (Times Roman Bold Italic), 'CourierRegular' (Courier), 'CourierItalic' (Courier Italic), 'CourierBold' (Courier Bold), 'CourierBoldItalic' (Courier Bold Italic), 'Symbol' (Text symbol letters)

Default

"Helv"

Font size.

Additional custom properties. Only available for use with DsPdf.

Annotation id.

true if the annotation is hidden.

Internal helper property. Primary annotation's children annotations. Note, the array contains all children annotations, including annotations what is not direct descendant of the primary annotation.

Specifies whether or not the RichContent mode is used for the contents property.

Specifies whether the annotation can be deleted or its properties (including position and size) can be modified by the user.

Example

var viewer = new DsPdfViewer('#root', { renderInteractiveForms: true , supportApi: { apiUrl: 'api/pdf-viewer', webSocketUrl: false } });
viewer.addDefaultPanels();
viewer.addAnnotationEditorPanel();
viewer.addFormEditorPanel();
viewer.addReplyTool();
viewer.onAfterOpen.register(()=>{
    // Lock all text annotations after document open:
    const resultArr = await viewer.findAnnotation(1, // 1 - AnnotationTypeCode.TEXT
                          { findField: 'annotationType',
                  		    pageNumberConstraint: 1, findAll: true });
    viewer.updateAnnotations(0, resultArr.map((data)=> { data.annotation.locked = true; return data.annotation; }));
});
// Open Annotations.pdf
viewer.open('Annotations.pdf');

Modification date.

Annotation opacity.

The field order index.

The number of degrees by which the widget annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90. Default value: 0.

Resolved reference to parent annotation.

Parent annotation id for popup annotation.

Popup id if any.

Specifies whether or not the annotation can be printed.

Read-only flag.

The annotation's bounds rectangle: [x1, y1, x2, y2]. (0, 0) is the bottom left corner of the page.

Indicates whether the current annotation has been redacted. Redacted annotations will be removed from the document after saving.

ID of the Redact annotation that was used to redact the current annotation.

Id of the primary annotation to which this annotation belongs. ("in reply to" value).

R - this annotation is reply to the primary annotation specified by field referenceAnnotationId. Group - annotation should be grouped with primary annotation specified by field referenceAnnotationId.

The number of degrees by which the annotation shall be rotated relative to the page.

Hash object with information about users who change this annotation. key - user name value - UNIX UTC timestamp when changes were added.

Beginning with PDF 1.5, Annotations may have author-specific state associated with them. The state is not specified in the annotation itself but in separate text annotation that refers to the original annotation by means of its 'IRT' ("in reply to") entry.

The state model corresponding to state.

Text representing a short description of the subject being addressed by the annotation. The 'subject' is the meta information property and it can be used to group, sort or filter annotations.

Annotation sub-type. Possible values are: 'Text', 'Link', 'FreeText', 'Line', 'Square', 'Circle', 'Polygon', 'PolyLine', 'Highlight', 'Underline', 'Squiggly', 'Strikeout', 'Stamp', 'Caret', 'Ink', 'Popup', 'FileAttachment', 'Sound', 'Movie', 'Widget', 'Screen', 'PrinterMark', 'TrapNet', 'WaterMark', 'Redact', 'Signature', 'ThreadBead', 'RadioButton', 'Checkbox', 'PushButton', 'Choice', 'TextWidget', 'RichMedia'

The alignment of the text.

The text label that shall be displayed in the title bar of the annotation's popup when open and active. This entry shall identify the user who added the annotation.