Search results

CheckBoxFieldSettings API in Angular PDF Viewer API component

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 = {
     name: '',
     isChecked: true,
     backgroundColor: 'white',
     isReadOnly: false,
     visibility: 'visible',
     isPrint: true,
     tooltip: '',
     isRequired: false,
     thickness: 5,
     borderColor: 'black'
 };
 viewer.appendTo("#pdfViewer");

Properties

backgroundColor

string

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

borderColor

string

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

bounds

IFormFieldBound

Get or set the form field bounds.

isChecked

boolean

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

isPrint

boolean

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

isReadOnly

boolean

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

isRequired

boolean

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

name

string

Get or set the name of the check box.

pageNumber

number

specifies the page number of the form field.

thickness

number

Get or set the thickness of the check box field.

tooltip

string

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

value

string

Get or set the value of the check box.

visibility

Visibility

Gets or set the visibility of the form field.