TextField

Class: TextField

Represents a text field.

Extends

Field

Extended by

CombTextField

Constructors

Constructor

new TextField(om): TextField;

Creates a new TextField.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the TextField.

Returns

TextField

Overrides

Field.constructor

Constructor

new TextField(): TextField;

Creates a new TextField.

Returns

TextField

Overrides

Field.constructor

Accessors

alternateName

Get Signature

get alternateName(): string;

Gets or sets 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.

Returns

string

Set Signature

set alternateName(value): void;

Parameters

value

string

Returns

void

Inherited from

Field.alternateName

calculationIndex

Get Signature

get calculationIndex(): number;

Gets or sets 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.

recalculateValue can be used to specify JavaScript that is used to calculate the field's value.

Returns

number

Set Signature

set calculationIndex(value): void;

Gets or sets 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.

recalculateValue can be used to specify JavaScript that is used to calculate the field's value.

Parameters

value

number

Returns

void

Inherited from

Field.calculationIndex

children

Get Signature

get children(): FieldCollection;

Gets the list of child fields.

Returns

FieldCollection

Inherited from

Field.children

defaultStyleString

Get Signature

get defaultStyleString(): string;

Gets or sets the default style string used when the field value is specified using TextField#richTextValue. See PDF specification for details. Note that DsPdfJS does not automatically regenerates appearance streams for text fields containing RTF text.

Returns

string

Set Signature

set defaultStyleString(value): void;

Parameters

value

string

Returns

void

defaultText

Get Signature

get defaultText(): string;

Gets or sets the default text of this TextField, applied when the field is reset.

Returns

string

Set Signature

set defaultText(value): void;

Gets or sets the default text of this TextField, applied when the field is reset.

Parameters

value

string

Returns

void

defaultValue

Get Signature

get defaultValue(): string | number | boolean | number[];

Gets or sets the field's default value.

Returns

string | number | boolean | number[]

Set Signature

set defaultValue(value): void;

Gets or sets the field's default value.

Parameters

value

string | number | boolean | number[]

Returns

void

Inherited from

Field.defaultValue

doc

Get Signature

get doc(): PdfDocument;

Gets the PdfDocument owning this field.

Returns

PdfDocument

Inherited from

Field.doc

export

Get Signature

get export(): boolean;

Gets or sets a value indicating whether the field must not be exported by a ActionSubmitForm action.

Returns

boolean

Set Signature

set export(value): void;

Gets or sets a value indicating whether the field must not be exported by a ActionSubmitForm action.

Parameters

value

boolean

Returns

void

Inherited from

Field.export

formatValue

Get Signature

get formatValue(): ActionJavaScript;

Gets or sets a JavaScript action to be performed before the field is formatted to display its current value. This action can modify the field's value before formatting.

Returns

ActionJavaScript

Set Signature

set formatValue(value): void;

Gets or sets a JavaScript action to be performed before the field is formatted to display its current value. This action can modify the field's value before formatting.

Parameters

value

| ActionJavaScriptProperties | ActionJavaScript

Returns

void

Inherited from

Field.formatValue

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

Field.id

justification

Get Signature

get justification(): VariableTextJustification;

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

Returns

VariableTextJustification

Set Signature

set justification(value): void;

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

Parameters

value

VariableTextJustification

Returns

void

Inherited from

Field.justification

keyPress

Get Signature

get keyPress(): ActionJavaScript;

Gets or sets a JavaScript action to be performed when the user types a keystroke into a text field or combo box or modifies the selection in a scrollable list box. This action can check the keystroke for validity and reject or modify it.

Returns

ActionJavaScript

Set Signature

set keyPress(value): void;

Parameters

value

| ActionJavaScriptProperties | ActionJavaScript

Returns

void

Inherited from

Field.keyPress

mappingName

Get Signature

get mappingName(): string;

Gets or sets the mapping name to be used when exporting interactive form field data from the document.

Returns

string

Set Signature

set mappingName(value): void;

Gets or sets the mapping name to be used when exporting interactive form field data from the document.

Parameters

value

string

Returns

void

Inherited from

Field.mappingName

maxLen

Get Signature

get maxLen(): number;

Gets or sets the maximum length of the field's text, in characters.

Returns

number

Set Signature

set maxLen(value): void;

Gets or sets the maximum length of the field's text, in characters.

Parameters

value

number

Returns

void

multiline

Get Signature

get multiline(): boolean;

Gets or sets a value indicating whether the field can contain multiple lines of text.

Returns

boolean

Set Signature

set multiline(value): void;

Gets or sets a value indicating whether the field can contain multiple lines of text.

Parameters

value

boolean

Returns

void

name

Get Signature

get name(): string;

Gets or sets the field's name.

Returns

string

Set Signature

set name(value): void;

Gets or sets the field's name.

Parameters

value

string

Returns

void

Inherited from

Field.name

om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

Field.om

owner

Get Signature

get owner(): FieldCollection;

Gets the FieldCollection containing this field.

Returns

FieldCollection

Inherited from

Field.owner

page

Get Signature

get page(): PdfPage;

Gets or sets the PdfPage containing this field. This property wraps the WidgetAnnotation#page property and functions identically to: this.widget.page = value;

Note that a field may have multiple associated annotations across different pages. These can be added and configured using the @widgets property.

See

WidgetAnnotation#page

Returns

PdfPage

Set Signature

set page(value): void;

Gets or sets the PdfPage containing this field. This property wraps the WidgetAnnotation#page property and functions identically to: this.widget.page = value;

Note that a field may have multiple associated annotations across different pages. These can be added and configured using the @widgets property.

See

WidgetAnnotation#page

Parameters

value

PdfPage

Returns

void

parent

Get Signature

get parent(): Field;

Gets the parent field.

Returns

Field

Inherited from

Field.parent

password

Get Signature

get password(): boolean;

Gets or sets a value indicating whether the field is intended for entering a secure password that should not be echoed visibly to the screen.

Returns

boolean

Set Signature

set password(value): void;

Gets or sets a value indicating whether the field is intended for entering a secure password that should not be echoed visibly to the screen.

Parameters

value

boolean

Returns

void

readOnly

Get Signature

get readOnly(): boolean;

Gets or sets a value 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.

Returns

boolean

Set Signature

set readOnly(value): void;

Parameters

value

boolean

Returns

void

Inherited from

Field.readOnly

recalculateValue

Get Signature

get recalculateValue(): ActionJavaScript;

Gets or sets a JavaScript action to be performed to recalculate the value of this field when that of another field changes.

Returns

ActionJavaScript

Set Signature

set recalculateValue(value): void;

Gets or sets a JavaScript action to be performed to recalculate the value of this field when that of another field changes.

Parameters

value

| ActionJavaScriptProperties | ActionJavaScript

Returns

void

Inherited from

Field.recalculateValue

rect

Get Signature

get rect(): Rect;

Gets or sets the rectangle that defines the location and size of the field on a page. This property wraps the WidgetAnnotation#rect property and functions identically to: this.widget.rect = value;

Note that a field may have multiple associated annotations across different pages. These can be added and configured using the @widgets property.

See

WidgetAnnotation#rect

Returns

Rect

Set Signature

set rect(value): void;

Gets or sets the rectangle that defines the location and size of the field on a page. This property wraps the WidgetAnnotation#rect property and functions identically to: this.widget.rect = value;

Note that a field may have multiple associated annotations across different pages. These can be added and configured using the @widgets property.

See

WidgetAnnotation#rect

Parameters

value

Rect

Returns

void

required

Get Signature

get required(): boolean;

Gets or sets a value indicating whether the field must have a value at the time it is exported by a ActionSubmitForm action.

Returns

boolean

Set Signature

set required(value): void;

Gets or sets a value indicating whether the field must have a value at the time it is exported by a ActionSubmitForm action.

Parameters

value

boolean

Returns

void

Inherited from

Field.required

richText

Get Signature

get richText(): boolean;

Gets or sets a value indicating whether the value of this field should be represented as a rich text string.

Returns

boolean

Set Signature

set richText(value): void;

Gets or sets a value indicating whether the value of this field should be represented as a rich text string.

Parameters

value

boolean

Returns

void

richTextValue

Get Signature

get richTextValue(): string;

Gets or sets the rich text to be displayed in the TextField. This text can be formatted using HTML tags, see PDF specification for details. Note that DsPdfJS does not automatically regenerates appearance streams for text fields containing RTF text.

Returns

string

Set Signature

set richTextValue(value): void;

Parameters

value

string

Returns

void

scrollable

Get Signature

get scrollable(): boolean;

Gets or sets a value indicating whether the field is scrollable to accommodate more text than fits within its annotation rectangle.

Returns

boolean

Set Signature

set scrollable(value): void;

Gets or sets a value indicating whether the field is scrollable to accommodate more text than fits within its annotation rectangle.

Parameters

value

boolean

Returns

void

spellCheck

Get Signature

get spellCheck(): boolean;

Gets or sets a value indicating whether the text entered in the field is spell-checked.

Returns

boolean

Set Signature

set spellCheck(value): void;

Gets or sets a value indicating whether the text entered in the field is spell-checked.

Parameters

value

boolean

Returns

void

text

Get Signature

get text(): string;

Gets or sets the text of TextField.

Returns

string

Set Signature

set text(value): void;

Gets or sets the text of TextField.

Parameters

value

string

Returns

void

value

Get Signature

get value(): string | number | boolean | number[];

Gets or sets the field's value.

Returns

string | number | boolean | number[]

Set Signature

set value(value): void;

Gets or sets the field's value.

Parameters

value

string | number | boolean | number[]

Returns

void

Inherited from

Field.value

valueChanged

Get Signature

get valueChanged(): ActionJavaScript;

Gets or sets a JavaScript action to be performed when the field's value is changed. This action can check the new value for validity.

Returns

ActionJavaScript

Set Signature

set valueChanged(value): void;

Gets or sets a JavaScript action to be performed when the field's value is changed. This action can check the new value for validity.

Parameters

value

| ActionJavaScriptProperties | ActionJavaScript

Returns

void

Inherited from

Field.valueChanged

Get Signature

get widget(): WidgetAnnotation;

Gets the WidgetAnnotation defining view properties of the text field.

Returns

WidgetAnnotation

widgets

Get Signature

get widgets(): FieldWidgetCollection;

Gets the list of widget annotations associated with this field.

Returns

FieldWidgetCollection

Inherited from

Field.widgets

Methods

free()

free(): void;

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

Field.free

rebind()

rebind(omTo): void;

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo

ObjectManager

The new ObjectManager for the object.

Returns

void

Inherited from

Field.rebind