iTextSharp.text.pdf.XfaForm Class Reference

Classes
class	AcroFieldsSearch
class	InverseStore
class	Stack2
class	Xml2Som
class	Xml2SomDatasets
class	Xml2SomTemplate

Public Member Functions
	XfaForm ()
	XfaForm (PdfReader reader)
void	SetXfa (PdfWriter writer)
String	FindFieldName (String name, AcroFields af)
String	FindDatasetsName (String name)
XmlNode	FindDatasetsNode (String name)
void	SetNodeText (XmlNode n, String text)

Static Public Member Functions
static PdfObject	GetXfaObject (PdfReader reader)
static void	SetXfa (XfaForm form, PdfReader reader, PdfWriter writer)
static byte[]	SerializeDoc (XmlNode n)
static String	GetNodeText (XmlNode n)

Static Public Attributes
const String	XFA_DATA_SCHEMA = "http://www.xfa.org/schema/xfa-data/1.0/"

Properties
bool	XfaPresent [get, set]
XmlDocument	DomDocument [get, set]
PdfReader	Reader [get, set]
bool	Changed [get, set]
Xml2SomTemplate	TemplateSom [get, set]
Xml2SomDatasets	DatasetsSom [get, set]
AcroFieldsSearch	AcroFieldsSom [get, set]
XmlNode	DatasetsNode [get]

Detailed Description

Processes XFA forms.

Author

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

Constructor & Destructor Documentation

XfaForm() [1/2]

iTextSharp.text.pdf.XfaForm.XfaForm

(

)

An empty constructor to build on.

XfaForm() [2/2]

iTextSharp.text.pdf.XfaForm.XfaForm

(

PdfReader

reader

)

A constructor from a PdfReader. It basically does everything from finding the XFA stream to the XML parsing.

Parameters

reader

the reader

Exceptions

java.io.IOException	on error
javax.xml.parsers.ParserConfigurationException	on error
org.xml.sax.SAXException	on error

Member Function Documentation

FindDatasetsName()

String iTextSharp.text.pdf.XfaForm.FindDatasetsName

(

String

name

)

Finds the complete SOM name contained in the datasets section from a possibly partial name.

Parameters

name	the complete or partial name

Returns

the complete name or null if not found

FindDatasetsNode()

XmlNode iTextSharp.text.pdf.XfaForm.FindDatasetsNode

(

String

name

)

Finds the Node contained in the datasets section from a possibly partial name.

Parameters

name	the complete or partial name

Returns

the Node or null if not found

FindFieldName()

String iTextSharp.text.pdf.XfaForm.FindFieldName	(	String	name,
		AcroFields	af
	)

Finds the complete field name contained in the "classic" forms from a partial name.

Parameters

name	the complete or partial name
af	the fields

Returns

the complete name or null if not found

GetNodeText()

static String iTextSharp.text.pdf.XfaForm.GetNodeText ( XmlNode  n )

static

Gets all the text contained in the child nodes of this node.

Parameters

n

the Node

Returns

the text found or "" if no text was found

GetXfaObject()

static PdfObject iTextSharp.text.pdf.XfaForm.GetXfaObject ( PdfReader  reader )

static

Return the XFA Object, could be an array, could be a Stream. Returns null f no XFA Object is present.

Parameters

reader

a PdfReader instance

Returns

the XFA object

Since

2.1.3

SerializeDoc()

static byte [] iTextSharp.text.pdf.XfaForm.SerializeDoc ( XmlNode  n )

static

Serializes a XML document to a byte array.

Parameters

n	the XML document

Exceptions

java.io.IOException

on error

Returns

the serialized XML document

SetNodeText()

void iTextSharp.text.pdf.XfaForm.SetNodeText	(	XmlNode	n,
		String	text
	)

Sets the text of this node. All the child's node are deleted and a new child text node is created.

Parameters

n	the Node to add the text to
text	the text to add

SetXfa() [1/2]

void iTextSharp.text.pdf.XfaForm.SetXfa

(

PdfWriter

writer

)

Sets the XFA key from the instance data. The old XFA is erased.

Parameters

writer

the writer

Exceptions

java.io.IOException

on error

SetXfa() [2/2]

static void iTextSharp.text.pdf.XfaForm.SetXfa ( XfaForm  form, PdfReader  reader, PdfWriter  writer  )

static

Sets the XFA key from a byte array. The old XFA is erased.

Parameters

form	the data
reader	the reader
writer	the writer

Exceptions

java.io.IOException

on error

Member Data Documentation

XFA_DATA_SCHEMA

const String iTextSharp.text.pdf.XfaForm.XFA_DATA_SCHEMA = "http://www.xfa.org/schema/xfa-data/1.0/"

static

Property Documentation

AcroFieldsSom

AcroFieldsSearch iTextSharp.text.pdf.XfaForm.AcroFieldsSom

getset

Gets the class that contains the "classic" fields processing.

Returns

the class that contains the "classic" fields processing

Changed

bool iTextSharp.text.pdf.XfaForm.Changed

getset

Checks if this XFA form was changed.

Returns

true if this XFA form was changed

DatasetsNode

XmlNode iTextSharp.text.pdf.XfaForm.DatasetsNode

get

Gets the Node that corresponds to the datasets part.

Returns

the Node that corresponds to the datasets part

DatasetsSom

Xml2SomDatasets iTextSharp.text.pdf.XfaForm.DatasetsSom

getset

Gets the class that contains the datasets processing section of the XFA.

Returns

the class that contains the datasets processing section of the XFA

DomDocument

XmlDocument iTextSharp.text.pdf.XfaForm.DomDocument

getset

Gets the top level DOM document.

Returns

the top level DOM document

Reader

PdfReader iTextSharp.text.pdf.XfaForm.Reader

getset

Sets the PdfReader to be used by this instance.

Parameters

reader

the PdfReader to be used by this instance

TemplateSom

Xml2SomTemplate iTextSharp.text.pdf.XfaForm.TemplateSom

getset

Gets the class that contains the template processing section of the XFA.

Returns

the class that contains the template processing section of the XFA

XfaPresent

bool iTextSharp.text.pdf.XfaForm.XfaPresent

getset

Returns true if it is a XFA form.

Returns

true if it is a XFA form

---

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

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