iTextSharp.text.pdf.FdfWriter Class Reference

Classes
class	Wrt

Public Member Functions
	FdfWriter ()
void	WriteTo (Stream os)
bool	RemoveField (String field)
Hashtable	GetFields ()
String	GetField (String field)
bool	SetFieldAsName (String field, String value)
bool	SetFieldAsString (String field, String value)
bool	SetFieldAsAction (String field, PdfAction action)
void	SetFields (FdfReader fdf)
void	SetFields (PdfReader pdf)
void	SetFields (AcroFields af)

Properties
String	File [get, set]

Detailed Description

Writes an FDF form.

Author

Paulo Soares (psoar.nosp@m.es@c.nosp@m.onsis.nosp@m.te.p.nosp@m.t)

Constructor & Destructor Documentation

FdfWriter()

iTextSharp.text.pdf.FdfWriter.FdfWriter

(

)

Creates a new FdfWriter.

Member Function Documentation

GetField()

String iTextSharp.text.pdf.FdfWriter.GetField

(

String

field

)

Gets the field value.

Parameters

field

the field name

Returns

the field value or null if not found

GetFields()

Hashtable iTextSharp.text.pdf.FdfWriter.GetFields

(

)

Gets all the fields. The map is keyed by the fully qualified field name and the values are PdfObject.

Returns

a map with all the fields

RemoveField()

bool iTextSharp.text.pdf.FdfWriter.RemoveField

(

String

field

)

Removes the field value.

Parameters

field

the field name

Returns

true if the field was found and removed, false otherwise

SetFieldAsAction()

bool iTextSharp.text.pdf.FdfWriter.SetFieldAsAction	(	String	field,
		PdfAction	action
	)

Sets the field value as a PDFAction. For example, this method allows setting a form submit button action using PdfAction#createSubmitForm(String, Object[], int). This method creates an A entry for the specified field in the underlying FDF file. Method contributed by Philippe Laflamme (plaflamme)

Parameters

field	the fully qualified field name
action	the field's action

Returns

true if the value was inserted, false if the name is incompatible with an existing field

Since

2.1.5

SetFieldAsName()

bool iTextSharp.text.pdf.FdfWriter.SetFieldAsName	(	String	field,
		String	value
	)

Sets the field value as a name.

Parameters

field	the fully qualified field name
value	the value

Returns

true if the value was inserted, false if the name is incompatible with an existing field

SetFieldAsString()

bool iTextSharp.text.pdf.FdfWriter.SetFieldAsString	(	String	field,
		String	value
	)

Sets the field value as a string.

Parameters

field	the fully qualified field name
value	the value

Returns

true if the value was inserted, false if the name is incompatible with an existing field

SetFields() [1/3]

void iTextSharp.text.pdf.FdfWriter.SetFields

(

AcroFields

af

)

Sets all the fields from this AcroFields

Parameters

acro	the AcroFields

SetFields() [2/3]

void iTextSharp.text.pdf.FdfWriter.SetFields

(

FdfReader

fdf

)

Sets all the fields from this FdfReader

Parameters

fdf	the FdfReader

SetFields() [3/3]

void iTextSharp.text.pdf.FdfWriter.SetFields

(

PdfReader

pdf

)

Sets all the fields from this PdfReader

Parameters

pdf	the PdfReader

WriteTo()

void iTextSharp.text.pdf.FdfWriter.WriteTo

(

Stream

os

)

Writes the content to a stream.

Parameters

os	the stream

Exceptions

DocumentException	on error
IOException	on error

Property Documentation

File

String iTextSharp.text.pdf.FdfWriter.File

getset

Gets the PDF file name associated with the FDF.

Returns

the PDF file name associated with the FDF

---

The documentation for this class was generated from the following file:

• src/core/iTextSharp/text/pdf/FdfWriter.cs