DsPdfJS API - v9.1.0
    Preparing search index...

    Class CombTextField

    Represents the text field divided into as many equally spaced positions, or combs, as the value of CombTextField#maxLen, and the text is laid out into those combs.

    Hierarchy (View Summary)

    Index

    Constructors

    Accessors

    • get alternateName(): string | null

      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 | null

    • set alternateName(value: string | null): void

      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.

      Parameters

      • value: string | null

      Returns void

    • 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 calculationIndex(value: number): 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

    • get defaultStyleString(): string | null

      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 | null

    • set defaultStyleString(value: string | null): void

      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.

      Parameters

      • value: string | null

      Returns void

    • get defaultText(): string | null

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

      Returns string | null

    • set defaultText(value: string | null): void

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

      Parameters

      • value: string | null

      Returns void

    • get defaultValue(): string | number | boolean | number[] | null

      Gets or sets the field's default value.

      Returns string | number | boolean | number[] | null

    • set defaultValue(value: string | number | boolean | number[] | null): void

      Gets or sets the field's default value.

      Parameters

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

      Returns void

    • get export(): boolean

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

      Returns boolean

    • set export(value: boolean): void

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

      Parameters

      • value: boolean

      Returns void

    • get formatValue(): ActionJavaScript | null

      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 | null

    • set formatValue(
          value: ActionJavaScriptProperties | ActionJavaScript | null,
      ): 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.

      Returns void

    • get id(): number

      Gets the reference to the object.

      Returns number

    • get keyPress(): ActionJavaScript | null

      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 | null

    • set keyPress(value: ActionJavaScriptProperties | ActionJavaScript | null): void

      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 void

    • get mappingName(): string | null

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

      Returns string | null

    • set mappingName(value: string | null): void

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

      Parameters

      • value: string | null

      Returns void

    • get maxLen(): number

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

      Returns number

    • set maxLen(value: number): void

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

      Parameters

      • value: number

      Returns void

    • get multiline(): boolean

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

      Returns boolean

    • set multiline(value: boolean): void

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

      Parameters

      • value: boolean

      Returns void

    • get name(): string | null

      Gets or sets the field's name.

      Returns string | null

    • set name(value: string): void

      Gets or sets the field's name.

      Parameters

      • value: string

      Returns void

    • get page(): PdfPage | null

      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.

      Returns PdfPage | null

    • set page(value: PdfPage | null): 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.

      Parameters

      Returns void

    • get parent(): Field | null

      Gets the parent field.

      Returns Field | null

    • 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 password(value: boolean): 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

    • 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 readOnly(value: boolean): void

      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.

      Parameters

      • value: boolean

      Returns void

    • get recalculateValue(): ActionJavaScript | null

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

      Returns ActionJavaScript | null

    • set recalculateValue(
          value: ActionJavaScriptProperties | ActionJavaScript | null,
      ): void

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

      Returns void

    • 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.

      Returns Rect

    • set rect(value: Rect): 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.

      Parameters

      Returns void

    • 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 required(value: boolean): 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

    • 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 richText(value: boolean): 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

    • get richTextValue(): string | null

      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 | null

    • set richTextValue(value: string | null): void

      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.

      Parameters

      • value: string | null

      Returns void

    • 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 scrollable(value: boolean): 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

    • get spellCheck(): boolean

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

      Returns boolean

    • set spellCheck(value: boolean): void

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

      Parameters

      • value: boolean

      Returns void

    • get text(): string | null

      Gets or sets the text of TextField.

      Returns string | null

    • set text(value: string | null): void

      Gets or sets the text of TextField.

      Parameters

      • value: string | null

      Returns void

    • get value(): string | number | boolean | number[] | null

      Gets or sets the field's value.

      Returns string | number | boolean | number[] | null

    • set value(value: string | number | boolean | number[] | null): void

      Gets or sets the field's value.

      Parameters

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

      Returns void

    • get valueChanged(): ActionJavaScript | null

      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 | null

    • set valueChanged(
          value: ActionJavaScriptProperties | ActionJavaScript | null,
      ): 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.

      Returns void

    Methods

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

      Returns void