CheckBoxFieldSettings

6 Jul 20262 minutes to read

The CheckBoxFieldSettings is used to to show and customize the appearance of check box element.

<div id="pdfViewer" style="height: 100%;width: 100%;"></div>
 let viewer: PdfViewer = new PdfViewer();
 // Change the check box field settings.
 viewer.checkBoxFieldSettings = {
     bounds: { x:0,y:0, width: 0, height: 0 },
     name: '',
     value: '',
     isChecked: true,
     pageNumber: 0,
     backgroundColor: 'white',
     isReadOnly: false,
     visibility: 'visible',
     isPrint: true,
     tooltip: '',
     isRequired: false,
     thickness: 5,
     borderColor: 'black',
     customData: null
 };
 viewer.appendTo("#pdfViewer");

Properties

backgroundColor string

Get or set the background color of the check box in hexadecimal string format.

Defaults to ‘white’

borderColor string

Get or set the border color of the check box field.

Defaults to ‘#303030’

bounds IFormFieldBound

Get or set the form field bounds.

Defaults to { x: 0, y: 0, width: 0, height: 0 }

customData object

specifies the custom data of the form fields.

Defaults to null

isChecked boolean

Specifies whether the check box is in checked state or not.

Defaults to false

isPrint boolean

Get or set the boolean value to print the check box field. TRUE by default.

Defaults to false

isReadOnly boolean

Specifies whether the check box field is in read-only or read-write mode. FALSE by default.

Defaults to false

isRequired boolean

If it is set as true, consider as mandatory field in the PDF document. By default it is false.

Defaults to false

name string

Get or set the name of the check box.

Defaults to ’’

pageNumber number

specifies the page number of the form field.

Defaults to 0

thickness number

Get or set the thickness of the check box field.

Defaults to 1

tooltip string

Get or set the text to be displayed as tooltip. By default it is empty.

Defaults to ’’

value string

Get or set the value of the check box.

Defaults to ’’

visibility Visibility

Gets or set the visibility of the form field.

Defaults to ‘visible’