ComPDFKit Web SDK
    Preparing search index...

    Class WidgetFlags

    Form field flags (/Ff) of a field, read and written by name.

    Index
    • Takes the /Ff value; also accepts an options object: mask is the names this group of flags knows (for submit forms), onUpdate is unused, starting from 0.

      Parameters

      • Optionalbits: number | Record<string, unknown>

      Returns WidgetFlags

    • Whether a flag is set.

      Parameters

      • flag: string

        Flag name, such as WidgetFlags.READ_ONLY.

      Returns boolean

      True when set; false for unknown names.

    • Unknown names are ignored.

      Parameters

      • flag: string
      • Optionalvalue: boolean

      Returns void

    COMB: "Comb"

    Text field: the text is split into equally spaced character cells (requires a maximum length).

    COMBO: "Combo"

    Choice field: the field is a combo box (otherwise a list box).

    COMMIT_ON_SEL_CHANGE: "CommitOnSelChange"

    Choice field: the value is committed as soon as the selection changes.

    DO_NOT_SCROLL: "DoNotScroll"

    Text field: the text does not scroll beyond the visible area.

    DO_NOT_SPELL_CHECK: "DoNotSpellCheck"

    Text and choice fields: the text is not spell-checked.

    EDIT: "Edit"

    Combo box: the user can type a value of their own.

    FILE_SELECT: "FileSelect"

    Text field: the value is the path of a file to submit.

    MULTI_SELECT: "MultiSelect"

    List box: more than one option can be selected.

    MULTILINE: "Multiline"

    Text field: the text can span multiple lines.

    NO_EXPORT: "NoExport"

    The field is not exported when the form is submitted.

    NO_TOGGLE_TO_OFF: "NoToggleToOff"

    Radio button: exactly one button must be selected at all times.

    PASSWORD: "Password"

    Text field: the text is masked as a password.

    PUSH_BUTTON: "PushButton"

    Button field: the field is a push button.

    RADIO: "Radio"

    Button field: the field is a set of radio buttons.

    RADIOS_IN_UNISON: "RadiosInUnison"

    Radio buttons with the same export value turn on and off together.

    READ_ONLY: "ReadOnly"

    The field is read-only.

    REQUIRED: "Required"

    The field must have a value when the form is submitted.

    RICH_TEXT: "RichText"

    Text field: the value is rich text.

    SORT: "Sort"

    Choice field: the options are sorted.