Public Types | |
enum | Type { Type.e_FDF = 0, Type.e_XFDF = 1 } |
Enumeration for FDF document type. More... | |
Public Member Functions | |
FDFDoc (FileReaderCallback file_read) | |
Constructor, with a file read callback object. More... | |
FDFDoc (FDFDoc.Type type) | |
Constructor. More... | |
FDFDoc (string path) | |
Constructor, from an existing FDF or XFDF file path. More... | |
FDFDoc (global::System.IntPtr buffer, uint length) | |
Constructor, from a memory buffer. More... | |
FDFDoc (FDFDoc other) | |
Constructor, with another fdf document object. | |
PDFDictionary | GetCatalog () |
Get the catalog dictionary. More... | |
PDFDictionary | GetFDFDict () |
Get the dictionary of "FDF" entry from catalog dictionary. More... | |
string | GetPDFPath () |
Get the path of related PDF document. More... | |
FDFDoc.Type | GetType () |
Get the type of current document object. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
bool | SaveAs (string file_path) |
Save current document as another FDF or XFDF file. More... | |
bool | SaveAs (FileWriterCallback file) |
Save current document as another FDF or XFDF file. More... | |
bool | SetPDFPath (string pdf_path) |
Set the path of related PDF document. More... | |
FDF (Forms Data Format) is a kind of file format, used for interactive form data. FDF can be used when submitting form data to a server, receiving the response, and incorporating it into the interactive form. It can also be used to export form data to stand-alone files that can be stored, transmitted electronically, and imported back into the corresponding PDF interactive form. Besides these, FDF can be used to define a container for annotations that are separated from the PDF document to which they apply.
XFDF(XML Forms Data Format) is a version of FDF based on XML. It has similar features with FDF.
In a word, FDF and XFDF contain the subset of a PDF document to describe interactive forms and annotations.
Class fdf::FDFDoc can be used to represent either FDF or XFDF. A fdf::FDFDoc object can be constructed with an existing file from file path, memory buffer, a custom implemented ReaderCallback object and an input file stream. A fdf::FDFDoc can also be constructed as a new FDF or XFDF document. This class also offers functions to get or set some information from FDF or XFDF file, and save current FDF/XFDF as another file.
To import or export form fields or annotations, please refer to functions pdf::PDFDoc::ImportFromFDF, pdf::PDFDoc::ExportToFDF and pdf::PDFDoc::ExportAnnotToFDF.
|
strong |
|
inline |
Constructor, with a file read callback object.
file_read | Pointer to a ReaderCallback object which is implemented by user to load a FDF or XFDF document. It should not be null. |
|
inline |
Constructor.
This constructor is to construct a new fdf::FDFDoc object (without any data).
|
inline |
Constructor, from an existing FDF or XFDF file path.
path | A full path of an existing FDF/XFDF file. It should not be an empty string. |
|
inline |
Constructor, from a memory buffer.
buffer | A memory buffer. The FDF or XFDF file data should be fully loaded in this memory buffer. It should not be null. |
length | The size of memory buffer. It should be above 0. |
|
inline |
Get the catalog dictionary.
|
inline |
Get the dictionary of "FDF" entry from catalog dictionary.
|
inline |
Get the path of related PDF document.
The path can be either an absolute one, or a relative one.
|
inline |
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
Save current document as another FDF or XFDF file.
file_path | A full path of the new saved FDF or XFDF file. It should not be an empty string. |
|
inline |
Save current document as another FDF or XFDF file.
file | A WriterCallback object which is implemented by user to save FDF or XFDF file. |
|
inline |
Set the path of related PDF document.
pdf_path | The path of related PDF document. It can be either an absolute path or a relative path. It should not be an empty string. |