Class SubmitForm

This class represents a SubmitForm action. ActionType

Inheritance

System.Object

SubmitForm

Implements

IAction

Namespace: PSPDFKit.Pdf.Actions

Assembly: PSPDFKit.dll

Syntax

public sealed class SubmitForm : IAction

Constructors

SubmitForm(String)

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

Declaration

public SubmitForm(string uri)

Parameters

Type	Name	Description
System.String	uri

Properties

ActionType

The type of the action. ActionType

Declaration

public ActionType ActionType { get; }

Property Value

Type	Description
ActionType

CanonicalFormat

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

Declaration

public bool CanonicalFormat { get; set; }

Property Value

Type	Description
System.Boolean

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

public bool EmbedForm { get; set; }

Property Value

Type	Description
System.Boolean

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

public bool ExcludeFKey { get; set; }

Property Value

Type	Description
System.Boolean

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

public bool ExcludeNonUserAnnotations { get; set; }

Property Value

Type	Description
System.Boolean

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

public bool ExportFormat { get; set; }

Property Value

Type	Description
System.Boolean

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

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

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

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

public bool GetMethod { get; set; }

Property Value

Type	Description
System.Boolean

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

public bool IncludeAnnotations { get; set; }

Property Value

Type	Description
System.Boolean

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

public bool IncludeAppendSaves { get; set; }

Property Value

Type	Description
System.Boolean

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

public bool IncludeExclude { get; set; }

Property Value

Type	Description
System.Boolean

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

public bool IncludeNoValueFields { get; set; }

Property Value

Type	Description
System.Boolean

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

public bool SubmitCoordinated { get; set; }

Property Value

Type	Description
System.Boolean

SubmitPdf

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

Declaration

public bool SubmitPdf { get; set; }

Property Value

Type	Description
System.Boolean

Uri

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

Declaration

public string Uri { get; set; }

Property Value

Type	Description
System.String

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

public bool Xfdf { get; set; }

Property Value

Type	Description
System.Boolean

Methods

FromJson(JsonObject)

Constructs an IAction from Instant JSON. See https://pspdfkit.com/guides/server/current/document/json-format/

Declaration

public static IAction FromJson(JsonObject json)

Parameters

Type	Name	Description
Windows.Data.Json.JsonObject	json	The Instant JSON representing the IAction.

Returns

Type	Description
IAction	The IAction represented by the Instant JSON.

ToJson()

Converts the action to its JSON representation. See https://pspdfkit.com/guides/server/current/document/json-format/#toc_action-types

Declaration

public JsonObject ToJson()

Returns

Type	Description
Windows.Data.Json.JsonObject	A JsonObject containing the action.

Implements

IAction