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

    Class RadioButtonField

    Represents group of radio buttons.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    alternateName calculationIndex children defaultValue doc export formatValue id justification keyPress mappingName name om opt owner parent radiosInUnison readOnly recalculateValue required value valueChanged widgets

    Methods

    addItem free rebind

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

      Parameters

      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.

      Parameters

      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 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 opt(): string[] | null

      Gets or sets an array of strings containing one entry for each widget annotation, defining export values for its constituent radio buttons. See the PDF spec for details.

      Returns string[] | null

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

      Gets or sets an array of strings containing one entry for each widget annotation, defining export values for its constituent radio buttons. See the PDF spec for details.

      Parameters

      • value: string[] | null

      Returns void

    • get parent(): Field | null

      Gets the parent field.

      Returns Field | null

    • get radiosInUnison(): boolean

      Gets or sets a value indicating whether a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive (the same behavior as HTML radio buttons).

      Returns boolean

    • set radiosInUnison(value: boolean): void

      Gets or sets a value indicating whether a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive (the same behavior as HTML radio buttons).

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

      Parameters

      Returns void

    Methods

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

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods