Skip to content

# PDFSubmitFormAction

Namespace: O2S.Components.PDF4NET.Actions

Defines a submit form action.

    public class PDFSubmitFormAction : PDFAction

Inheritance Object → PDFAction → PDFSubmitFormAction

Remarks

A submit form action transmits the names and values of selected interactive form fields to a specified uniform resource locator (URL).

## Constructors

### PDFSubmitFormAction()

Initializes a new PDFSubmitFormAction object.

    public PDFSubmitFormAction()

## Properties

### Actions

Gets or sets the sequence of actions to be performed after this action.

    public PDFActionCollection Actions { get; set; }

Property Value

PDFActionCollection
The sequence of actions to be performed after this action.

### CosAction

Gets the cos action object.

    public PDFCosDictionary CosAction { get; }

Property Value

PDFCosDictionary
The cos action dictionary.

Remarks

Direct changes to cos action dictionary can lead to unexpected results if they do not follow the PDF specification.

### DataFormat

Gets or sets the format of the submitted data.

    public PDFSubmitDataFormat DataFormat { get; set; }

Property Value

PDFSubmitDataFormat
The format, one of the formats defined by PDFSubmitDataFormat enumeration, of the data submitted to the server.

### EmbedForm

Gets or sets a value indicating whether the PDF file is embedded in the submitted data.

    public bool EmbedForm { get; set; }

Property Value

Boolean
If true, the PDF file is embedded in the submitted FDF file.

Remarks

This property is meaningful only if the submit data format is FDF.

### ExcludeNonUserAnnotations

Gets or sets a value indicating whether only the annotations created by the current user are submitted.

    public bool ExcludeNonUserAnnotations { get; set; }

Property Value

Boolean
If true, only the annotations created by the current are submitted.

Remarks

This property is meaningful only if the submit data format is FDF and PDFSubmitFormAction.IncludeAnnotations property is true.

### Fields

Gets or sets the list identifying which fields to include in the submission or which to exclude.

    public List<string> Fields { get; set; }

Property Value

List<String>
A list of strings identifying which fields to include in the submission or which to exclude, depending on the setting of the PDFSubmitFormAction.SubmitFields property.

Remarks

If this list is null or empty then all the form fields are submitted regardless of the PDFSubmitFormAction.SubmitFields property.
The fields with PDFField.Export property set to true will not be submitted no matter if they are included in the list or not.

### IncludeAnnotations

Gets or sets a value indicating whether the submitted FDF file includes all markup annotations in the underlying PDF document.

    public bool IncludeAnnotations { get; set; }

Property Value

Boolean
If true, the submitted FDF file includes all markup annotations in the underlying PDF document.

Remarks

This property is meaningful only if the submit data format is FDF.

### IncludeAppendSaves

Gets or sets a value indicating whether the incremental updates to the underlying PDF document are included in the submitted FDF file.

    public bool IncludeAppendSaves { get; set; }

Property Value

Boolean
If true, the submitted FDF file includes the contents of all incremental updates to the underlying PDF document.

Remarks

This property is meaningful only when the submit data format is FDF.

### IncludeNoValueFields

Gets or sets a value indicating whether the fields with no value are submitted.

    public bool IncludeNoValueFields { get; set; }

Property Value

Boolean
If true, all fields designated by the PDFSubmitFormAction.Fields list and the PDFSubmitFormAction.SubmitFields property are submitted, regardless of whether they have a value.

### SubmitCoordinates

Gets or sets a value indicating whether the coordinates of the mouse click that caused the submit form action are transmitted as part of form data.

    public bool SubmitCoordinates { get; set; }

Property Value

Boolean
If true, the coordinates of the mouse click that caused the submit-form action are transmitted as part of the form data.

Remarks

The coordinate values are relative to the upper-left corner of the field's widget annotation rectangle.

### SubmitFields

Gets or sets a value indicating whether the fields in PDFSubmitFormAction.Fields list should be submitted or not.

    public bool SubmitFields { get; set; }

Property Value

Boolean
True if the fields in PDFSubmitFormAction.Fields list should be submitted, false if the fields in the list should be omitted.

### Type

Gets the type of this action.

    public PDFActionType Type { get; }

Property Value

PDFActionType
A PDFActionType enum member specifying the type of this action.

### Url

Gets or sets the URL the form data is submitted for processing.

    public string Url { get; set; }

Property Value

String
The URL the form data is submitted for processing.

### UseCanonicalDateTimeFormat

Gets or sets a value indicating whether the field values representing dates are converted to the standard PDF format.

    public bool UseCanonicalDateTimeFormat { get; set; }

Property Value

Boolean
If true, any submitted field values representing dates are converted to the standard PDF format.

### UseHttpGet

Gets or sets a value indicating whether the form data is submitted using HTTP GET method.

    public bool UseHttpGet { get; set; }

Property Value

Boolean
If true, form data is submitted using an HTTP GET request. If false, it is submitted using a POST request.

Remarks

This property is considered only if PDFSubmitFormAction.DataFormat property is PDFSubmitDataFormat.HTML or PDFSubmitDataFormat.PDF.