Package com.pspdfkit.annotations.actions

Enum SubmitFormAction.SubmitFormActionFlag

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      INCLUDE_EXCLUDE

      If set, the getFieldNames specifies fields to exclude from submit action. If not set, the getFieldNames specifies which fields to include in the submission.
      INCLUDE_NO_VALUE_FIELDS

      If set, the target fields (getFormFieldsAsync) shall be submitted regardless of whether they have a value. If not set, fields without a value shall not be submitted.
      EXPORT_FORMAT

      If set, field names and values shall be submitted in HTML Form format. If not set, they shall be submitted in Forms Data format (FDF).

      Meaningful only if the SUBMIT_PDF and XFDF flags are not set.
      GET_METHOD

      If set, field names and values shall be submitted using an HTTP GET request. If clear, they shall be submitted using a POST request.

      This flag is meaningful only when the EXPORT_FORMAT flag is set. If EXPORT_FORMAT flag is not set, this flag also should not be set.
      SUBMIT_COORDINATES

      If set, the coordinates of the mouse click that caused the submit-form action shall be transmitted as part of the form data.

      This flag shall be used only when the EXPORT_FORMAT flag is set. If EXPORT_FORMAT flag is not set, this flag also should not be set.
      XFDF

      If set, field names and values shall be submitted as XFDF.

      This flag shall be used only if the SUBMIT_PDF flag is not set.
      INCLUDE_APPEND_SAVES

      If set, the submitted FDF file shall include the contents of all incremental updates to the underlying PDF document.

      This flag shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and EXPORT_FORMAT flags are clear).
      INCLUDE_ANNOTATIONS

      If set, the submitted FDF file shall include all annotations in the underlying PDF document.

      This flag shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and EXPORT_FORMAT flags are clear).
      SUBMIT_PDF

      If set, the document shall be submitted as PDF, using the MIME content type application/pdf. If set, all other flags shall be ignored except GET_METHOD.
      CANONICAL_FORMAT

      If set, any submitted field values representing dates shall be converted to the standard PDF format.
      EXCLUDE_NON_USER_ANNOTATIONS

      If set, it form submission data shall include only those annotations whose creator property matches the name of the current user.

      This flag shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and EXPORT_FORMAT flags are clear).
      EMBED_FORM

      If set, form submission data shall include embedded file stream representing the PDF file from which the data is being submitted.

      This flag shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and EXPORT_FORMAT flags are clear).

    • Constructor Detail

    • Method Detail

      • values

         static Array<SubmitFormAction.SubmitFormActionFlag> values()

        Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.

        Returns:

        an array containing the constants of this enum type, in the order they're declared

      • valueOf

         static SubmitFormAction.SubmitFormActionFlag valueOf(String name)

        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

        Returns:

        the enum constant with the specified name