FormField

6 Jul 20263 minutes to read

The FormField is used to store the form fields of PDF document.

Properties

alignment TextAlignment

Get or set the text alignment of the form field.

Defaults to ‘Left’

backgroundColor string

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

Defaults to ‘white’

borderColor string

Get or set the border color of the form 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 form field in hexadecimal string format.

Defaults to ‘black’

customData object

specifies the custom data of the form field.

Defaults to null

fontFamily string

Get or set the font family of the form field.

Defaults to ‘Helvetica’

fontName string

specifies the fontName of the signature.

Defaults to ’’

fontSize number

Get or set the font size of the form field.

Defaults to 10

fontStyle FontStyle

Get or set the font Style of form field.

Defaults to ‘None’

id string

Gets the id of the form field.

Defaults to ’’

isChecked boolean

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

Defaults to false

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 form field. TRUE by default.

Defaults to false

isReadOnly boolean

If it is set as true, can’t edit the form field in the PDF document. By default it is false.

Defaults to false

isRequired boolean

Gets or set the is Required of form field.

Defaults to false

isSelected boolean

Specifies whether the radio button is in selected state or not.

Defaults to false

isTransparent boolean

Get the isTransparent of the form field. Default value is false.

Defaults to false

maxLength number

Get or set the maximum character length.

Defaults to 0

name string

Gets the name of the form field.

Defaults to ’’

options ItemModel[]

Get or set the form field items. This can be Dropdown items or Listbox items.

Defaults to []

pageIndex number

Get the pageIndex of the form field. Default value is -1.

Defaults to -1

pageNumber number

Get the pageNumber of the form field. Default value is 1.

Defaults to 1

rotateAngle number

Get the rotateAngle of the form field. Default value is 0.

Defaults to 0

selectedIndex number[]

Get the selectedIndex of the form field. Default value is null.

Defaults to []

signatureIndicatorSettings SignatureIndicatorSettingsModel

Specifies the properties of the signature indicator in the signature field.

signatureType SignatureType[]

specifies the type of the signature.

Defaults to [’’]

thickness number

Get or set the thickness of the form field.

Defaults to 1

tooltip string

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

Defaults to ’’

type FormFieldType

Gets the type of the form field.

Defaults to ’’

value string

Gets or sets the value of the form field.

Defaults to ’’

visibility Visibility

Gets or set the visibility of the form field.

Defaults to ‘visible’

zIndex number

Get the zIndex of the form field. Default value is 0.

Defaults to 0