ComPDFKit Web SDK
    Preparing search index...

    Class SubmitForm

    Submit-form action: sends form field values to a URL as XFDF or as an HTML form.

    Hierarchy

    • Action
      • SubmitForm
    Index
    • get exclude(): boolean

      Whether fields lists fields to leave out rather than fields to submit.

      Returns boolean

    • get fields(): string[]

      Names of the listed fields; empty when all fields are submitted.

      Returns string[]

    • get flags(): WidgetFlags

      The remaining submit flags (names from SUBMIT_FORM_FLAGS). Assign a flag name, a list of names (each is turned on) or the raw bits.

      Returns WidgetFlags

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

      The remaining submit flags (names from SUBMIT_FORM_FLAGS). Assign a flag name, a list of names (each is turned on) or the raw bits.

      Parameters

      • value: string | number | string[]

      Returns void

    • get format(): string

      Data format, such as 'xfdf' (default) or 'html'.

      Returns string

    • get includeEmpty(): boolean

      Whether fields without a value are submitted.

      Returns boolean

    • get method(): string

      HTTP method name recorded on the action, such as 'POST' (default) or 'GET'.

      Returns string

    • get url(): string

      Address the form data is sent to; an empty string when not set.

      Returns string

    • Creates a submit-form action.

      Parameters

      • Optionalinit: SubmitFormInit

        Optional initial values.

      Returns SubmitForm

    • Applies the given values; omitted or falsy values leave the current ones unchanged.

      Parameters

      • Optionalinit: SubmitFormInit

        Values to apply.

      Returns void

    elementName: string

    Action type name, always 'SubmitForm'.