Button field widget.

Hierarchy

Properties

alternativeText?: string

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.

annotationName: string

Annotation name (NM entry).

annotationType: AnnotationTypeCode

Annotation type.

appearanceColor?: string

Appearance color.

borderStyle?: { dashArray?: number[]; horizontalCornerRadius: number; style: number; verticalCornerRadius: number; width: number }

Annotation's border style.

Type declaration

  • Optional dashArray?: number[]

    Border dash pattern. Used when the border style is dashed.

  • horizontalCornerRadius: number
  • style: number

    Border style. Possible values: 1 - solid style (default), 2 - dashed style.

  • verticalCornerRadius: number
  • width: number

    Border width.

checkBox: boolean

If set, indicates that this button is a checkbox.

color?: string

Annotation color.

contents?: string

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

convertToContent?: boolean

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

creationDate: string

Creation date.

display?: "visible" | "hidden"

The field is used for compatibility with Adobe Acrobat Reader.

exportValue: string

Export value, used by radio/checkbox buttons.

fieldName: string

Field name.

Field type.

fieldValue: string | string[]

Field widget value.

fontName: string

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"

fontSize: number

Font size.

gcProps?: GcProps

Additional custom properties. Only available for use with DsPdf.

id: string

Annotation id.

invisibleFlag: boolean

true if the annotation is hidden.

irtAnnotations?: AnnotationBase[]

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.

isRichContents: boolean

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

locked: boolean

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');
modificationDate: string

Modification date.

opacity?: number

Annotation opacity.

orderIndex: number

The field order index.

orientation?: number

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.

parentAnnotation?: AnnotationBase

Resolved reference to parent annotation.

parentId?: string

Parent annotation id for popup annotation.

popupId?: string

Popup id if any.

printableFlag: boolean

Specifies whether or not the annotation can be printed.

pushButton: boolean

If set, indicates that this button is a push button.

radioButton: boolean

If set, indicates that this button is a radio button.

radiosInUnison: boolean

If set, a group of radio buttons with same name (within a radio button field) that use the same value for the on state see:exportValue will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive (the same behavior as HTML radio buttons).

Default

false

readOnly: boolean

Read-only flag.

rect: number[]

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

redacted: boolean

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

redactedBy: string

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

referenceAnnotationId: string

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

referenceType: "R" | "Group"

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.

resetForm: boolean

If set, indicates that this button is used to reset form.

rotate?: number

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

sharedChanges?: { [userName: string]: number }

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

Type declaration

  • [userName: string]: number

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.

subject: string

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.

submitForm: boolean

If set, indicates that this button is used to submit form.

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

textAlignment: TextAlignmentType

The alignment of the text.

title: string

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.