SubmitFormAction
Overview
SubmitFormAction is a class in Aspose.PDF FOSS for .NET.
Inherits from: PdfAction.
Submit-form action — sends form field data to a URL or remote file (PDF 32000-1:2008 §12.7.5.2).
This class provides 8 methods for working with SubmitFormAction objects in .NET programs.
Available methods include: CreateGoTo, CreateJavaScript, CreateLaunch, CreateNamed, CreateUri, GetECMAScriptString, SubmitFormAction, ToString.
All public members are accessible to any .NET application after installing the Aspose.PDF FOSS for .NET package.
Properties: CanonicalFormat, EmbedForm, ExclFKey, ExclNonUserAnnots, Exclude, ExportFormat, and 11 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
Url | FileSpecification? | Read/Write | The destination URL/file specification (/F entry). |
Flags | int | Read/Write | The flags integer (/Flags entry) — bitwise OR of submit-form flags per PDF spec table 237. |
Exclude | int | Read | Treat the listed field array as an exclude-list rather than an include-list (bit 1 of /Flags per PDF spec table 237). |
IncludeNoValueFields | int | Read | Submit empty fields as well as filled ones (bit 2 of /Flags). |
ExportFormat | int | Read | Submit field names and values in HTML form-encoded format (bit 3 of /Flags). |
GetMethod | int | Read | Use HTTP GET instead of POST when submitting the form (bit 4 of /Flags). |
SubmitCoordinates | int | Read | Include the submit-button click coordinates with the posted data (bit 5 of /Flags). |
Xfdf | int | Read | Submit the field data as XFDF rather than FDF (bit 6 of /Flags). |
IncludeAppendSaves | int | Read | Include incremental-save update entries in the FDF payload (bit 7 of /Flags). |
IncludeAnnotations | int | Read | Include markup annotations in the FDF payload (bit 8 of /Flags). |
SubmitPdf | int | Read | Submit the entire PDF as the request body (bit 9 of /Flags). |
CanonicalFormat | int | Read | Convert dates to standard PDF canonical format before submission (bit 10 of /Flags). |
ExclNonUserAnnots | int | Read | Exclude non-user-edited markup annotations when IncludeAnnotations is set (bit 11 of /Flags). |
ExclFKey | int | Read | Exclude the /F (font) entry from each annotation when IncludeAnnotations is set (bit 12 of /Flags). |
EmbedForm | int | Read | Embed the PDF inside the submitted FDF payload (bit 14 of /Flags). |
Type | ActionType | Read | The action type. |
Next | Annotations.ActionCollection | Read | The /Next chain — actions that fire after this one. |
Methods
| Signature | Description |
|---|---|
SubmitFormAction() | Create an empty SubmitForm action. |
GetECMAScriptString() | For JavaScript actions, returns the embedded script; otherwise an empty string. |
CreateGoTo(pageIndex: int, fitType: string) | Create a GoTo action targeting a page index with the specified fit type. |
CreateUri(uri: string) | Create a URI action that opens the specified URL. |
CreateJavaScript(script: string) | Create a JavaScript action that executes the specified script. |
CreateNamed(name: string) | Create a Named action (e.g., NextPage, PrevPage, FirstPage, LastPage). |
CreateLaunch(filePath: string) | Create a Launch action that opens the specified file. |
ToString() | Human-readable representation of this appointment target. |