PdfInteractiveForm Class

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

An interactive form (PDF 1.2)—sometimes referred to as an AcroForm—is a collection of fields for gathering information interactively from the user. A PDF document may contain any number of fields appearing on any combination of pages, all of which make up a single, global interactive form spanning the entire document.

public sealed class PdfInteractiveForm : PdfObject
Public NotInheritable Class PdfInteractiveForm
    Inherits PdfObject
Inheritance:
System.Object
PdfInteractiveForm

Properties

Fields

Gets the fields.

public PdfFieldCollection Fields { get; }
Public ReadOnly Property Fields As PdfFieldCollection
Property Value
PdfFieldCollection

The fields.

See Also

NeedAppearances

(Optional; deprecated in PDF 2.0) A flag specifying whether to construct appearance streams and appearance dictionaries for all widget annotations in the document (see 12.7.3.3, "Variable text").

Default value: false.

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

A flag specifying whether to construct appearance streams and appearance dictionaries for all widget annotations in the document.

Remarks

A PDF writer shall include this key, with a value of true, if it has not provided appearance streams for all visible widget annotations present in the document.

note

Appearance streams are required in PDF 2.0.

See Also

Methods

ExportData(Stream, PdfFormDataFormat)

Exports the interactive form data from the current PdfInteractiveForm to the specified FDF or XFDF stream.

public void ExportData(Stream stream, PdfFormDataFormat format)
Public Sub ExportData(stream As Stream, format As PdfFormDataFormat)
Parameters
stream
System.IO.Stream

The FDF or XFDF stream to which to export the interactive form data.

format
PdfFormDataFormat

The format in which interactive form data is exported (either FDF or XFDF).

Exceptions
System.ArgumentNullException

stream is null.

System.ArgumentException

PDF interactive form can be exported to either FDF or XFDF file format.

See Also

ExportData(String)

Exports the interactive form data from the current PdfInteractiveForm to an FDF or XFDF file with the specified path.

public void ExportData(string path)
Public Sub ExportData(path As String)
Parameters
path
System.String

The path to an FDF or XFDF file to which to export the interactive form data.

Remarks

Following file extensions are supported:

  • Forms Data Format: .fdf
  • XML Forms Data Format: .xfdf
Exceptions
System.ArgumentNullException

path is null.

System.ArgumentException

If file extension is not specified or not supported.

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