FormField

23 Sep 20252 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.

backgroundColor string

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

borderColor string

Get or set the border color of the form field.

bounds IFormFieldBound

Get or set the form field bounds.

color string

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

customData object

specifies the custom data of the form field.

fontFamily string

Get or set the font family of the form field.

fontName string

specifies the fontName of the signature.

fontSize number

Get or set the font size of the form field.

fontStyle FontStyle

Get or set the font Style of form field.

id string

Gets the id of the form field.

isChecked boolean

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

isMultiline boolean

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

isPrint boolean

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

isReadOnly boolean

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

isRequired boolean

Gets or set the is Required of form field.

isSelected boolean

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

isTransparent boolean

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

maxLength number

Get or set the maximum character length.

name string

Gets the name of the form field.

options ItemModel[]

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

pageIndex number

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

pageNumber number

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

rotateAngle number

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

selectedIndex number[]

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

signatureIndicatorSettings SignatureIndicatorSettingsModel

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

signatureType SignatureType[]

specifies the type of the signature.

thickness number

Get or set the thickness of the form field.

tooltip string

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

type FormFieldType

Gets the type of the form field.

value string

Gets or sets the value of the form field.

visibility Visibility

Gets or set the visibility of the form field.

zIndex number

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