Class SubmitForm

This class represents a SubmitForm action.

Inheritance
object
ActionBase
SubmitForm
Namespace: PSPDFKit.Sdk.Models.Annotation.Actions
Assembly: Sdk.dll
Syntax
public sealed class SubmitForm : ActionBase

Constructors

| Edit this page View Source

SubmitForm(string)

Constructs the SubmitForm object with the Uri set to this Uri.

Declaration
public SubmitForm(string uri)
Parameters
Type Name Description
string uri

Properties

| Edit this page View Source

CanonicalFormat

This option is not supported yet. If true, any submitted field values representing dates shall be converted to the standard format.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public bool CanonicalFormat { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

EmbedForm

This option is not supported yet. shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If true, 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.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public bool EmbedForm { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

ExcludeFKey

This option is not supported yet. Shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If true, the submitted FDF shall exclude the F entry.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public bool ExcludeFKey { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

ExcludeNonUserAnnotations

This option is not supported yet. shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false) and the IncludeAnnotations flag is true. If true, it shall include only those markup annotations those T entry matches the name of the current user, as determined by the remote server to which the form is being submitted.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public bool ExcludeNonUserAnnotations { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

ExportFormat

Meaningful only if the submitPDF and xfdf flags are false. If set, field names and values shall be submitted in HTML Form format. If false, they shall be submitted in Forms Data Format (FDF)

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public bool ExportFormat { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

Fields

A List identifying which fields to submit or which to exclude from submitting, depending on the setting of the includeExclude flag. Each element of the array shall be a text string representing the fully qualified name of a field. If this entry is omitted, the includeExclude flag shall be ignored; all fields in the document’s interactive form are submitted.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public IList<string> Fields { get; set; }
Property Value
Type Description
IList<string>
| Edit this page View Source

GetMethod

If true, field names and values shall be submitted using an HTTP GET request. If false, they shall be submitted using a POST request. This flag is meaningful only when the exportFormat flag is set. If exportFormat is false, this flag shall also be false.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public bool GetMethod { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IncludeAnnotations

This option is not supported yet. shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If set, the submitted FDF file shall include all markup annotations in the underlying PDF document. If false, markup annotations shall not be included.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public bool IncludeAnnotations { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IncludeAppendSaves

This option is not supported yet. Shall be used only when the form is being submitted in Forms Data Format (that is, when both the XFDF and ExportFormat flags are false). If true, 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. If false, the incremental updates shall not be included.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public bool IncludeAppendSaves { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IncludeExclude

If false, the fields list specifies which fields to submit. If true, the fields list indicates which fields to exclude from submitting. That is, all fields in the document’s interactive form shall be submitted except those listed in the fields list.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public bool IncludeExclude { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IncludeNoValueFields

This option is not supported yet. If true, all fields designated by the Fields array and the IncludeExclude flag shall be submitted, regardless of whether they have a value. For fields without a value, only the field name shall be transmitted. If false, fields without a value shall not be submitted.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public bool IncludeNoValueFields { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

SubmitCoordinated

This option is not supported yet. If true, 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 and name.y=yval where name is the field’s name.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public bool SubmitCoordinated { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

SubmitPdf

If true, the document shall be submitted as PDF, using the MIME content type application/pdf.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public bool SubmitPdf { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

Uri

The uniform resource identifier (web link) defining where the form should be submitted to when this action is triggered.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public string Uri { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Xfdf

This option is not supported yet. Shall be used only if the SubmitPDF flags are false. If true, field names and values shall be submitted as XFDF.

Declaration
[JsonProperty(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public bool Xfdf { get; set; }
Property Value
Type Description
bool