TextFieldSettings

9 Jul 20263 minutes to read

The TextFieldSettings is used to to show and customize the appearance of text box HTML element.

<div id="pdfViewer" style="height: 100%;width: 100%;"></div>
 let viewer: PdfViewer = new PdfViewer();
 // Change the text field settings.
 viewer.textFieldSettings = {
     bounds: { x:0,y:0, width: 0, height: 0 },
     name: '',
     value: '',
     fontFamily: 'Courier',
     fontSize: 10,
     pageNumber: 0,
     fontStyle: 'None',
     color: 'black',
     borderColor: 'black',
     backgroundColor: 'white',
     alignment: 'Right',
     isReadOnly: false,
     visibility: 'visible',
     maxLength: 0,
     isRequired: false,
     isPrint: true,
     tooltip: '',
     thickness: 1,
     isMultiline: false,
     customData: null
 };
 viewer.appendTo("#pdfViewer");

Properties

alignment TextAlignment

Get or set the alignment of the text.

Defaults to ‘Left’

backgroundColor string

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

Defaults to ‘white’

borderColor string

Get or set the border color of the textbox field.

Defaults to ‘#303030’

bounds IFormFieldBound

Get or set the form field bounds.

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

color string

Get or set the font color of the textbox in hexadecimal string format.

Defaults to ‘black’

customData object

specifies the custom data of the form fields.

Defaults to null

fontFamily string

Get or set the font family of the textbox field.

Defaults to ‘Helvetica’

fontSize number

Get or set the font size of the textbox field.

Defaults to 10

fontStyle FontStyle

Get or set the font Style of textbox field.

Defaults to ‘None’

isMultiline boolean

Allows multiline input in the text field. FALSE, by default.

Defaults to false

isPrint boolean

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

Defaults to false

isReadOnly boolean

Specifies whether the textbox 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

maxLength number

Get or set the maximum character length.

Defaults to 0

name string

Get or set the name of the form field element.

Defaults to ’’

pageNumber number

specifies the page number of the form field.

Defaults to 0

thickness number

Get or set the thickness of the textbox 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 form field.

Defaults to ’’

visibility Visibility

Gets or set the visibility of the form field.

Defaults to ‘visible’