new AcroFormPasswordField()
- Source:
Extends
Members
color :string|rgba
- Source:
- Inherited From:
- Default Value:
- 'black'
The color of the text
Type:
- string | rgba
comb :boolean
- Source:
- Inherited From:
(PDF 1.5) May be set only if the MaxLen entry is present in the text field dictionary (see Table 229) and if the Multiline, Password, and FileSelect flags are clear. If set, the field shall be automatically divided into as many equally spaced positions, or combs, as the value of MaxLen, and the text is laid out into those combs.
Type:
- boolean
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
doNotScroll :boolean
- Source:
- Inherited From:
(PDF 1.4) If set, the field shall not scroll (horizontally for single-line fields, vertically for multiple-line fields) to accommodate more text than fits within its annotation rectangle. Once the field is full, no further text shall be accepted for interactive form filling; for noninteractive form filling, the filler should take care not to add more character than will visibly fit in the defined area.
Type:
- boolean
doNotSpellCheck :boolean
- Source:
- Inherited From:
(PDF 1.4) If set, text entered in the field shall not be spell-checked.
Type:
- boolean
fieldName :string
- Source:
- Inherited From:
- Default Value:
- null
(Optional) The partial field name (see 12.7.3.2, “Field Names”).
Type:
- string
fileSelect :boolean
- Source:
- Inherited From:
(PDF 1.4) If set, the text entered in the field represents the pathname of a file whose contents shall be submitted as the value of the field.
Type:
- boolean
fontName :string
- Source:
- Inherited From:
- 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
maxLength :number
- Source:
- Inherited From:
(Optional; inheritable) The maximum length of the field’s text, in characters.
Type:
- number
multiline :boolean
- Source:
- Inherited From:
If set, the field may contain multiple lines of text; if clear, the field’s text shall be restricted to a single line.
Type:
- boolean
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
page :number
- Source:
- Inherited From:
The page on which the AcroFormField is placed
Type:
- number
password :boolean
- Source:
- Overrides:
If set, the field is intended for entering a secure password that should not be echoed visibly to the screen. Characters typed from the keyboard shall instead be echoed in some unreadable form, such as asterisks or bullet characters. NOTE To protect password confidentiality, readers should never store the value of the text field in the PDF file if this flag is set.
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
richText :boolean
- Source:
- Inherited From:
(PDF 1.5) If set, the value of this field shall be a rich text string (see 12.7.3.4, “Rich Text Strings”). If the field has a value, the RV entry of the field dictionary (Table 222) shall specify the rich text string.
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:
- Inherited From:
- 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:
- Inherited From:
- 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