Table 237 – Flags for submit-form actions

Bit position

Name

Meaning

1

Include/Exclude

If clear, the Fields array (see Table 236 ) specifies which fields to include in the submission. (All descendants of the specified fields in the field hierarchy shall be submitted as well.)

If set, the Fields array tells which fields to exclude. All fields in the document’s interactive form shall be submitted exceptthose listed in the Fields array and those whose NoExport flag (see Ta b l e 221 ) is set and fields with no values if the IncludeNoValueFields flag is clear.

2

IncludeNoValueFields

If set, all fields designated by the Fields array and the Include/Exclude flag shall be submitted, regardless of whether they have a value (V entry in the field dictionary). For fields without a value, only the field name shall betransmitted.

If clear, fields without a value shall not be submitted.

3

ExportFormat

Meaningful only if the SubmitPDF and XFDF flags are clear. If set, field names and values shall be submitted in HTML Form format. If clear, they shall be submitted in Forms Data Format (FDF); see 12.7.7, “Forms Data Format.”

4

GetMethod

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 ExportFormat flag is set; if ExportFormat is clear, this flag shall also be clear.

5

SubmitCoordinates

If set, the coordinates of the mouse click that caused the submit-form action shall be transmitted as part of the form data. The coordinate values are relative to the upper-left corner of the field’s widget annotation rectangle. They shall be represented in the data in the format

name . x = xval & name . y = yval

where name is the field’s mapping name (TM in the field dictionary) if present; otherwise, name is the field name. If the value of the TM entry is a single ASCII SPACE (20h) character, both the name and the ASCII PERIOD (2Eh)following it shall be suppressed, resulting in the format

x = xval & y = yval

This flag shall be used only when the ExportFormat flag is set. If ExportFormat is clear, this flag shall also be clear.

6

XFDF

(PDF 1.4) shall be used only if the SubmitPDF flags are clear. If set, field names and values shall be submitted as XFDF.

7

IncludeAppendSaves

(PDF 1.4) shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are clear). If set, the submitted FDF file shall include the contents of all incremental updates to the underlying PDF document, as contained in the Differences entry in the FDF dictionary (see Table 243 ). If clear, the incremental updates shall not be included.

8

IncludeAnnotations

(PDF 1.4) shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are clear). If set, the submitted FDF file shall include includes all markup annotations in the underlying PDF document (see 12.5.6.2, “Markup Annotations” ). If clear, markup annotations shall not be included.

9

SubmitPDF

(PDF 1.4) If set, the document shall be submitted as PDF, using the MIME content type application / pdf (described in Internet RFC 2045, Multipurpose Internet Mail Extensions (MIME), Part One: Format of Internet Message Bodies; see the Bibliography ). If set, all other flags shall be ignored except GetMethod.

10

CanonicalFormat

(PDF 1.4) If set, any submitted field values representing dates shall be converted to the standard format described in 7.9.4, “Dates.”

NOTE 1 The interpretation of a form field as a date is not specified explicitly in the field itself but only in the JavaScript code that processes it.

11

ExclNonUserAnnots

(PDF 1.4) shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are clear) and the IncludeAnnotations flag is set. If set, it shall include only those markup annotations whose T entry (see Table 170 ) matches the name of the current user, as determined by the remote server to which the form is being submitted.

NOTE 2 The T entry for markup annotations specifies the text label that is displayed in the title bar of the annotation’s pop-up window and is assumed to represent the name of the user authoring the annotation.

NOTE 3 This allows multiple users to collaborate in annotating a single remote PDF document without affecting one another’s annotations.

12

ExclFKey

(PDF 1.4) shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are clear). If set, the submitted FDF shall exclude the F entry.

14

EmbedForm

(PDF 1.5) shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are clear). If set, the F entry of the submitted FDF shall be a file specification containing an embedded file stream representing the PDF file from which the FDF is being submitted.