Aspose.PDF FOSS

SubmitFormAction

SubmitFormAction

Overview

SubmitFormAction is a class in Aspose.Pdf FOSS for Java. Inherits from: PdfAction.

SubmitForm action — submits form data to a URL (ISO 32000-1:2008, §12.6.4.14).

Properties

Name	Type	Access	Description
`url`	`String`	Read	Returns the submission URL.
`flags`	`int`	Read	Returns the submission flags.
`fields`	`COSArray`	Read	Returns the field name/reference list, or {@code null} if all fields.
`FLAG_INCLUDE_EXCLUDE`	`int`	Read	Include/Exclude flag (Table 237, bit 1).
`FLAG_INCLUDE_NO_VALUE_FIELDS`	`int`	Read	Include fields with no value (bit 2).
`FLAG_EXPORT_FORMAT`	`int`	Read	Export as HTML form (bit 3).
`FLAG_GET_METHOD`	`int`	Read	Use HTTP GET (bit 4).
`FLAG_SUBMIT_COORDINATES`	`int`	Read	Submit mouse coordinates (bit 5).
`FLAG_XFDF`	`int`	Read	Submit as XFDF (bit 6).
`FLAG_INCLUDE_APPEND_SAVES`	`int`	Read	Include append-saves (bit 7).
`FLAG_INCLUDE_ANNOTATIONS`	`int`	Read	Include annotations (bit 8).
`FLAG_SUBMIT_PDF`	`int`	Read	Submit as PDF (bit 9).
`FLAG_CANONICAL_FORMAT`	`int`	Read	Canonical date format (bit 10).
`FLAG_EXCL_NON_USER_ANNOTS`	`int`	Read	Exclude non-user annotations (bit 11).
`FLAG_EXCL_F_KEY`	`int`	Read	Exclude F key (bit 12).
`FLAG_EMBED_FORM`	`int`	Read	Embed form in submission (bit 14).
`cOSDictionary`	`COSDictionary`	Read	Returns the underlying action dictionary.
`type`	`String`	Read	Returns the action type (/S entry).
`next`	`PdfAction`	Read	Returns the next action (/Next), if any.

Methods

Signature	Description
`SubmitFormAction(dict: COSDictionary)`	Parses a SubmitFormAction from an existing dictionary.
`SubmitFormAction(url: String)`	Creates a SubmitFormAction for the given URL.
`getUrl()` → `String`	Returns the submission URL.
`getFlags()` → `int`	Returns the submission flags.
`setFlags(flags: int)`	Sets the submission flags.
`getFields()` → `COSArray`	Returns the field name/reference list, or {@code null} if all fields.
`getCOSDictionary()` → `COSDictionary`	Returns the underlying action dictionary.
`getType()` → `String`	Returns the action type (/S entry).
`getNext()` → `PdfAction`	Returns the next action (/Next), if any.
`fromDictionary(dict: COSDictionary, doc: Document)` → `PdfAction`	Factory: creates the appropriate PdfAction subclass from a dictionary.

See Also

Aspose.PDF for Java — Enterprise API Reference