PdfFormManager Class


PdfFormManager Class

This class provides the options to control the pdf document form fields. It can be used to fill the existing form fields and save the pdf document.

Inheritance Hierarchy

SystemObject
SelectPdf.ExtrasPdfManager
SelectPdf.FormsPdfFormManager

Namespace: SelectPdf.Forms
Assembly: Select.Pdf.Extras (in Select.Pdf.Extras.dll) Version: 23.1

Syntax

Copy

public class PdfFormManager : PdfManager

Public Class PdfFormManager
	Inherits PdfManager

The PdfFormManager type exposes the following members.

Constructors

	Name	Description
	PdfFormManager	Instantiates the PdfFormManager object.

Top

Properties

	Name	Description
	DocumentInformation	PDF document information. Most of this property info is populated after Load. Some info is populated after Save. (Inherited from PdfManager.)
	Fields	Collection of pdf form fields from the current pdf document.
	Flatten	Gets or sets a value indicating whether to flatten the pdf form or not.
	NeedAppearances	Gets or sets a value indicating whether to set NeedAppearances flag of the pdf form or not.

Top

Methods

	Name	Description
	Close	Closes the opened pdf document. (Inherited from PdfManager.)
	Load(Byte)	Loads a pdf document from a byte array. (Inherited from PdfManager.)
	Load(Stream)	Loads a pdf document from the specified stream. (Inherited from PdfManager.)
	Load(String)	Loads a pdf document from an existing pdf file. (Inherited from PdfManager.)
	Load(Byte, String)	Loads a password protected pdf document from a byte array. (Inherited from PdfManager.)
	Load(Stream, String)	Loads a pdf document from a stream containing a password protected pdf document. (Inherited from PdfManager.)
	Load(String, String)	Loads a pdf document from an existing password protected pdf file. (Inherited from PdfManager.)
	RenameField	Renames the form field.
	Save	Saves the pdf document as byte array. (Inherited from PdfManager.)
	Save(Stream)	Saves the pdf document to the specified stream. (Inherited from PdfManager.)
	Save(String)	Saves the pdf document to the specified file. (Inherited from PdfManager.)

Top

Examples

The following sample code shows how the form manager can be instantiated and some fields filled:

Copy

// the initial file
string file = Server.MapPath("~/files/w-9.pdf");

// load the pdf form manager
PdfFormManager form = new PdfFormManager();
form.Load(file);

// fill some fields
PdfFormFieldTextBox name = 
    form.Fields["f1_1"] as PdfFormFieldTextBox;
name.Text = "This is my name";

PdfFormFieldTextBox businessName = 
    form.Fields["f1_2"] as PdfFormFieldTextBox;
businessName.Text = "This is my business name";

PdfFormFieldCheckBox clasifIndividual =
    form.Fields["c1_1"] as PdfFormFieldCheckBox;
clasifIndividual.Checked = true;

PdfFormFieldTextBox address =
    form.Fields["f1_7"] as PdfFormFieldTextBox;
address.Text = "This is my address";

PdfFormFieldTextBox city =
    form.Fields["f1_8"] as PdfFormFieldTextBox;
city.Text = "This is my city";

PdfFormFieldTextBox employer1 =
    form.Fields["f1_14"] as PdfFormFieldTextBox;
employer1.Text = "XX";

PdfFormFieldTextBox employer2 =
    form.Fields["f1_15"] as PdfFormFieldTextBox;
employer2.Text = "1234567";

PdfFormFieldTextBox ssn1 =
    form.Fields["f1_11"] as PdfFormFieldTextBox;
ssn1.Text = "123";

PdfFormFieldTextBox ssn2 =
    form.Fields["f1_12"] as PdfFormFieldTextBox;
ssn2.Text = "45";

PdfFormFieldTextBox ssn3 =
    form.Fields["f1_13"] as PdfFormFieldTextBox;
ssn3.Text = "6789";

// save pdf document
form.Save(Response, false, "Sample.pdf");

// close pdf document
form.Close();

' the initial file
Dim file As String = Server.MapPath("~/files/w-9.pdf")

' load the pdf form manager
Dim form As New PdfFormManager()
form.Load(file)

' fill some fields
Dim name As PdfFormFieldTextBox = _
    TryCast(form.Fields("f1_1"), PdfFormFieldTextBox)
name.Text = "This is my name"

Dim businessName As PdfFormFieldTextBox = _
    TryCast(form.Fields("f1_2"), PdfFormFieldTextBox)
businessName.Text = "This is my business name"

Dim clasifIndividual As PdfFormFieldCheckBox = _
    TryCast(form.Fields("c1_1"), PdfFormFieldCheckBox)
clasifIndividual.Checked = True

Dim address As PdfFormFieldTextBox = _
    TryCast(form.Fields("f1_7"), PdfFormFieldTextBox)
address.Text = "This is my address"

Dim city As PdfFormFieldTextBox = _
    TryCast(form.Fields("f1_8"), PdfFormFieldTextBox)
city.Text = "This is my city"

Dim employer1 As PdfFormFieldTextBox = _
    TryCast(form.Fields("f1_14"), PdfFormFieldTextBox)
employer1.Text = "XX"

Dim employer2 As PdfFormFieldTextBox = _
    TryCast(form.Fields("f1_15"), PdfFormFieldTextBox)
employer2.Text = "1234567"

Dim ssn1 As PdfFormFieldTextBox = _
    TryCast(form.Fields("f1_11"), PdfFormFieldTextBox)
ssn1.Text = "123"

Dim ssn2 As PdfFormFieldTextBox = _
    TryCast(form.Fields("f1_12"), PdfFormFieldTextBox)
ssn2.Text = "45"

Dim ssn3 As PdfFormFieldTextBox = _
    TryCast(form.Fields("f1_13"), PdfFormFieldTextBox)
ssn3.Text = "6789"

' save pdf document
form.Save(Response, False, "Sample.pdf")

' close pdf document
form.Close()

Reference

SelectPdf.Forms Namespace