# AcroFormPasswordField

## AcroForm~ AcroFormPasswordField

#### new AcroFormPasswordField()

Source:
  - modules/acroform.js, line 2301

### Extends

- AcroFormTextField
- AcroFormField

### Members

#### color :string|rgba

Source:
  - modules/acroform.js, line 1096
Inherited From:
  - AcroFormField#color
Default Value:
  - 'black'

The color of the text

##### Type:

- string | rgba

#### comb :boolean

Source:
  - modules/acroform.js, line 2216
Inherited From:
  - AcroFormTextField#comb

(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:
  - modules/acroform.js, line 1161
Inherited From:
  - AcroFormField#defaultValue
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:
  - modules/acroform.js, line 2195
Inherited From:
  - AcroFormTextField#doNotScroll

(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:
  - modules/acroform.js, line 2174
Inherited From:
  - AcroFormTextField#doNotSpellCheck

(PDF 1.4) If set, text entered in the field shall not be spell-checked.

##### Type:

- boolean

#### fieldName :string

Source:
  - modules/acroform.js, line 1001
Inherited From:
  - AcroFormField#fieldName
Default Value:
  - null

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

##### Type:

- string

#### fileSelect :boolean

Source:
  - modules/acroform.js, line 2153
Inherited From:
  - AcroFormTextField#fileSelect

(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:
  - modules/acroform.js, line 1020
Inherited From:
  - AcroFormField#fontName
Default Value:
  - 'helvetica'

The fontName of the font to be used.

##### Type:

- string

#### fontSize :number

Source:
  - modules/acroform.js, line 1058
Inherited From:
  - AcroFormField#fontSize
Default Value:
  - 0 (for auto)

The fontSize of the font to be used.

##### Type:

- number

#### fontStyle :string

Source:
  - modules/acroform.js, line 1039
Inherited From:
  - AcroFormField#fontStyle
Default Value:
  - 'normal'

The fontStyle of the font to be used.

##### Type:

- string

#### (readonly) hasAnnotation :boolean

Source:
  - modules/acroform.js, line 1242
Inherited From:
  - AcroFormField#hasAnnotation

Check if field has annotations

##### Type:

- boolean

#### (readonly) hasAppearanceStream :boolean

Source:
  - modules/acroform.js, line 1274
Inherited From:
  - AcroFormField#hasAppearanceStream

true if field has an appearanceStream

##### Type:

- boolean

#### height :number

Source:
  - modules/acroform.js, line 939
Inherited From:
  - AcroFormField#height
Default Value:
  - null

The height of the field.

##### Type:

- number

#### maxFontSize :number

Source:
  - modules/acroform.js, line 1077
Inherited From:
  - AcroFormField#maxFontSize
Default Value:
  - 0 (for auto)

The maximum fontSize of the font to be used.

##### Type:

- number

#### maxLength :number

Source:
  - modules/acroform.js, line 2270
Inherited From:
  - AcroFormTextField#maxLength

(Optional; inheritable) The maximum length of the field’s text, in characters.

##### Type:

- number

#### multiline :boolean

Source:
  - modules/acroform.js, line 2132
Inherited From:
  - AcroFormTextField#multiline

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:
  - modules/acroform.js, line 1360
Inherited From:
  - AcroFormField#noExport
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:
  - modules/acroform.js, line 1294
Inherited From:
  - AcroFormField#page

The page on which the AcroFormField is placed

##### Type:

- number

#### password :boolean

Source:
  - modules/acroform.js, line 2309
Inherited From:
  - AcroFormTextField#password

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:
  - modules/acroform.js, line 1316
Inherited From:
  - AcroFormField#readOnly
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:
  - modules/acroform.js, line 1338
Inherited From:
  - AcroFormField#required
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:
  - modules/acroform.js, line 2237
Inherited From:
  - AcroFormTextField#richText

(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:
  - modules/acroform.js, line 818
Inherited From:
  - AcroFormField#showWhenPrinted
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:
  - modules/acroform.js, line 1402
Inherited From:
  - AcroFormField#textAlign
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:
  - modules/acroform.js, line 1215
Inherited From:
  - AcroFormField#value
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:
  - modules/acroform.js, line 918
Inherited From:
  - AcroFormField#width
Default Value:
  - null

The width of the field.

##### Type:

- number

#### x :number

Source:
  - modules/acroform.js, line 876
Inherited From:
  - AcroFormField#x
Default Value:
  - null

The x-position of the field.

##### Type:

- number

#### y :number

Source:
  - modules/acroform.js, line 897
Inherited From:
  - AcroFormField#y
Default Value:
  - null

The y-position of the field.

##### Type:

- number