DsPdfJS API v9.1.0

DsPdfJS API / FieldBaseProperties

Type Alias: FieldBaseProperties

FieldBaseProperties = object

Defines common properties for all acroform fields.

See

Field

Properties

alternateName?

optional alternateName: string

An alternate field name to be used in place of the actual field name wherever the field must be identified in the user interface (such as in error or status messages referring to the field). This text is also useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes.

calculationIndex?

optional calculationIndex: number

An index that is used to determine the field's calculation order. Fields with lower indices are calculated before fields with higher indices.

If several fields have the same CalculationIndex, the calculation order is determined by the order of fields in the collection.

defaultValue?

optional defaultValue: number | string | boolean | number[] | null

The field's default value.

export?

optional export: boolean

Indicating whether the field must not be exported by a ActionSubmitForm action.

justification?

optional justification: VariableTextJustification

The justification to be used in displaying the field's text. Note that this field is used only if WidgetAnnotation#justification is not specified.

mappingName?

optional mappingName: string

The mapping name to be used when exporting interactive form field data from the document.

name?

optional name: string

The field's name.

page?

optional page: PdfPage

The default page where field appears. Note, this value is used if it is not specified using 'widget' property.

readOnly?

optional readOnly: boolean

Indicating whether 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.

required?

optional required: boolean

Indicating whether the field must have a value at the time it is exported by a ActionSubmitForm action.

value?

optional value: number | string | boolean | number[] | null

The field's value.