ContextQMD
Back to Jspdf

AcroFormCheckBox

docs/module-AcroForm-AcroFormCheckBox.html

4.2.19.7 KB
Original Source

new AcroFormCheckBox()

Source:

Extends

Members

appearanceState :any

Source:

Overrides:

(Required if the appearance dictionary AP contains one or more subdictionaries; PDF 1.2) The annotation's appearance state, which selects the applicable appearance stream from an appearance subdictionary (see Section 12.5.5, "Appearance Streams")

Type:
  • any

caption :string

Source:

Overrides:

From the PDF reference: (Optional, button fields only) The widget annotation's normal caption which shall be displayed when it is not interacting with the user. Unlike the remaining entries listed in this Table which apply only to widget annotations associated with pushbutton fields (see Pushbuttons in 12.7.4.2, "Button Fields"), the CA entry may be used with any type of button field, including check boxes (see Check Boxes in 12.7.4.2, "Button Fields") and radio buttons (Radio Buttons in 12.7.4.2, "Button Fields").

  • '8' = Cross,
  • 'l' = Circle,
  • '' = nothing
Type:
  • string

color :string|rgba

Source:

Inherited From:

Default Value:

  • 'black'

The color of the text

Type:
  • string | rgba

defaultValue :any

Source:

Inherited From:

Default Value:

  • null

(Optional; inheritable) The default value to which the field reverts when a reset-form action is executed (see 12.7.5.3, “Reset-Form Action”). The format of this value is the same as that of value.

Type:
  • any

fieldName :string

Source:

Inherited From:

Default Value:

  • null

(Optional) The partial field name (see 12.7.3.2, “Field Names”).

Type:
  • string

fontName :string

Source:

Overrides:

Default Value:

  • 'helvetica'

The fontName of the font to be used.

Type:
  • string

fontSize :number

Source:

Inherited From:

Default Value:

  • 0 (for auto)

The fontSize of the font to be used.

Type:
  • number

fontStyle :string

Source:

Inherited From:

Default Value:

  • 'normal'

The fontStyle of the font to be used.

Type:
  • string

(readonly) hasAnnotation :boolean

Source:

Inherited From:

Check if field has annotations

Type:
  • boolean

(readonly) hasAppearanceStream :boolean

Source:

Inherited From:

true if field has an appearanceStream

Type:
  • boolean

height :number

Source:

Inherited From:

Default Value:

  • null

The height of the field.

Type:
  • number

maxFontSize :number

Source:

Inherited From:

Default Value:

  • 0 (for auto)

The maximum fontSize of the font to be used.

Type:
  • number

noExport :boolean

Source:

Inherited From:

Default Value:

  • false

If set, the field shall not be exported by a submit-form action (see 12.7.5.2, “Submit-Form Action”)

Type:
  • boolean

noToggleToOff :boolean

Source:

Inherited From:

(Radio buttons only) If set, exactly one radio button shall be selected at all times; selecting the currently selected button has no effect. If clear, clicking the selected button deselects it, leaving no button selected.

Type:
  • boolean

page :number

Source:

Inherited From:

The page on which the AcroFormField is placed

Type:
  • number

pushButton :boolean

Source:

Inherited From:

If set, the field is a pushbutton that does not retain a permanent value.

Type:
  • boolean

radio :boolean

Source:

Inherited From:

If set, the field is a set of radio buttons; if clear, the field is a checkbox. This flag may be set only if the Pushbutton flag is clear.

Type:
  • boolean

radioIsUnison :boolean

Source:

Inherited From:

(PDF 1.5) If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive (the same behavior as HTML radio buttons).

Type:
  • boolean

readOnly :boolean

Source:

Inherited From:

Default Value:

  • false

If set, the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database.

Type:
  • boolean

required :boolean

Source:

Inherited From:

Default Value:

  • false

If set, the field shall have a value at the time it is exported by a submitform action (see 12.7.5.2, “Submit-Form Action”).

Type:
  • boolean

showWhenPrinted :boolean

Source:

Inherited From:

Default Value:

  • true

(PDF 1.2) If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of wether is is displayed on the screen. NOTE 2 This can be useful for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page.

Type:
  • boolean

textAlign :string

Source:

Overrides:

Default Value:

  • 'left'

(Optional; inheritable) A code specifying the form of quadding (justification) that shall be used in displaying the text: 'left', 'center', 'right'

Type:
  • string

value :any

Source:

Overrides:

Default Value:

  • null

(Optional; inheritable) The field’s value, whose format varies depending on the field type. See the descriptions of individual field types for further information.

Type:
  • any

width :number

Source:

Inherited From:

Default Value:

  • null

The width of the field.

Type:
  • number

x :number

Source:

Inherited From:

Default Value:

  • null

The x-position of the field.

Type:
  • number

y :number

Source:

Inherited From:

Default Value:

  • null

The y-position of the field.

Type:
  • number