PdfSubmitFormAction Class

Namespace:
GemBox.Pdf.Forms
Assembly:
GemBox.Pdf.dll

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

public sealed class PdfSubmitFormAction : PdfAction
Public NotInheritable Class PdfSubmitFormAction
    Inherits PdfAction
Inheritance:
System.Object
PdfSubmitFormAction

Properties

ActionType

Gets the SubmitForm value.

public override PdfActionType ActionType { get; }
Public Overrides ReadOnly Property ActionType As PdfActionType
Property Value
PdfActionType

The SubmitForm value.

Overrides

ExportFormat

Gets or sets the format in which the PDF form data is exported.

Default value: FDF.

public PdfFormDataFormat ExportFormat { get; set; }
Public Property ExportFormat As PdfFormDataFormat
Property Value
PdfFormDataFormat

The format in which the PDF form data is exported.

IncludeEmptyFields

Gets or sets a value indicating whether fields with no values are excluded from the submission.

Default value: false.

public bool IncludeEmptyFields { get; set; }
Public Property IncludeEmptyFields As Boolean
Property Value
System.Boolean

true if fields with no values are excluded from the submission; otherwise, false.

SelectedFields

Gets the names of the fields that are either included in the submission (if Excluded is false) or excluded from the submission (if Excluded is true).

Applicable only if All is false.

public PdfFormActionSelectedFieldCollection SelectedFields { get; }
Public ReadOnly Property SelectedFields As PdfFormActionSelectedFieldCollection
Property Value
PdfFormActionSelectedFieldCollection

The names of the fields that are either included in the submission or excluded from the submission.

Url

(Required) A uniform resource locator (URL) of the script at the Web server that will process the submission.

public string Url { get; set; }
Public Property Url As String
Property Value
System.String

A uniform resource locator (URL) of the script at the Web server that will process the submission.

Exceptions
System.ArgumentNullException

Value is null or System.String.Empty.

See Also

Inherited Properties

Metadata

(Optional; PDF 1.4) A metadata stream containing metadata for the component.

(Inherited from PdfObject)

Extension Methods

Examples

See Also