Pdfviewer - ButtonFieldSettings

18 Nov 20262 minutes to read

Represents the settings for a button form field.
This class is used to configure the appearance, behavior,
actions, and other properties of a button form field in a PDF document.

Properties

actions ActionsSettingsModel

Gets or sets the action settings associated with the button field.

Defaults to null

alignment TextAlignment

Gets or sets the text alignment of the button caption.

Defaults to ‘Center’

backgroundColor string

Gets or sets the background color of the button field.

Defaults to ‘white’

borderColor string

Gets or sets the border color of the button field.

Defaults to ‘#303030’

bounds IFormFieldBound

Gets or sets the bounds of the form field.

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

color string

Gets or sets the font color of the button field.

Defaults to ‘black’

customData object

Gets or sets the custom data associated with the form field.

Defaults to null

fontFamily string

Gets or sets the font family of the button field.

Defaults to ‘Helvetica’

fontSize number

Gets or sets the font size of the button field.

Defaults to 10

fontStyle FontStyle

Gets or sets the font style of the button field.

Defaults to ‘None’

isPrint boolean

Gets or sets the boolean value to print the button field. TRUE by default.

Defaults to true

isReadOnly boolean

Specifies whether the button field is in read-only 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

Gets or sets the name of the form field.

Defaults to ’’

pageNumber number

Gets or sets the page number in which the form field is placed.

Defaults to 0

text string

Gets or sets the display text of the button field.

Defaults to ’’

thickness number

Gets or sets the border thickness of the button field.

Defaults to 1

tooltip string

Gets or sets the tooltip text of the button field. By default it is empty.

Defaults to ’’

value string

Gets or sets the caption text of the button field.

Defaults to ’’

visibility Visibility

Gets or sets the visibility of the form field.

Defaults to ‘visible’