Foxit PDF SDK
|
Public Types | |
enum | Type { e_FDF = 0, e_XFDF = 1 } |
Enumeration for FDF document type. More... | |
Public Member Functions | |
FDFDoc (common::file::ReaderCallback *file_read) | |
Constructor, with a file read callback object. More... | |
FDFDoc (Type type) | |
Constructor. More... | |
FDFDoc (const char *path) | |
Constructor, from an existing FDF or XFDF file path. More... | |
FDFDoc (const wchar_t *path) | |
Constructor, from an existing FDF or XFDF file path. More... | |
FDFDoc (const void *buffer, size_t length) | |
Constructor, from a memory buffer. More... | |
FDFDoc (const FDFDoc &other) | |
Constructor, with another FDF document object. More... | |
~FDFDoc () | |
Destructor. | |
pdf::objects::PDFDictionary * | GetCatalog () const |
Get the catalog dictionary. More... | |
pdf::objects::PDFDictionary * | GetFDFDict () const |
Get the dictionary of "FDF" entry from catalog dictionary. More... | |
WString | GetPDFPath () |
Get the path of related PDF document. More... | |
Type | GetType () const |
Get the type of current document object. More... | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
bool | operator!= (const FDFDoc &other) const |
Not equal operator. More... | |
FDFDoc & | operator= (const FDFDoc &other) |
Assign operator. More... | |
bool | operator== (const FDFDoc &other) const |
Equal operator. More... | |
bool | SaveAs (const char *file_path) |
Save current document as another FDF or XFDF file. More... | |
bool | SaveAs (const wchar_t *file_path) |
Save current document as another FDF or XFDF file. More... | |
bool | SaveAs (foxit::common::file::WriterCallback *file) |
Save current document as another FDF or XFDF file. More... | |
bool | SetPDFPath (const wchar_t *pdf_path) |
Set the path of related PDF document. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. 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 FDFDoc can be used to represent either FDF or XFDF. A FDF document object can be constructed with an existing file from file path, memory buffer, a custom implemented common::file::ReaderCallback object and an input file stream. A FDF document object 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.
|
explicit |
Constructor, with a file read callback object.
[in] | file_read | Pointer to a common::file::ReaderCallback object which is implemented by user to load a FDF or XFDF document. It should not be NULL. |
|
explicit |
Constructor.
This constructor is to construct a new FDF document object (without any data).
[in] | type | FDF document type. It should be one of following values: fdf::FDFDoc::e_FDF, FDFDoc::e_XFDF |
|
explicit |
Constructor, from an existing FDF or XFDF file path.
[in] | path | A full path of an existing FDF/XFDF file. It should not be an empty string. |
|
explicit |
Constructor, from an existing FDF or XFDF file path.
[in] | path | A full path of an existing FDF/XFDF file. It should not be an empty string. |
foxit::fdf::FDFDoc::FDFDoc | ( | const void * | buffer, |
size_t | length | ||
) |
Constructor, from a memory buffer.
[in] | buffer | A memory buffer. The FDF or XFDF file data should be fully loaded in this memory buffer. It should not be NULL. |
[in] | length | The size of memory buffer. It should be above 0. |
foxit::fdf::FDFDoc::FDFDoc | ( | const FDFDoc & | other | ) |
Constructor, with another FDF document object.
[in] | other | Another FDF document object. |
pdf::objects::PDFDictionary* foxit::fdf::FDFDoc::GetCatalog | ( | ) | const |
Get the catalog dictionary.
pdf::objects::PDFDictionary* foxit::fdf::FDFDoc::GetFDFDict | ( | ) | const |
Get the dictionary of "FDF" entry from catalog dictionary.
WString foxit::fdf::FDFDoc::GetPDFPath | ( | ) |
Get the path of related PDF document.
The path can be either an absolute one, or a relative one.
Type foxit::fdf::FDFDoc::GetType | ( | ) | const |
Get the type of current document object.
bool foxit::fdf::FDFDoc::IsEmpty | ( | ) | const |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
bool foxit::fdf::FDFDoc::operator!= | ( | const FDFDoc & | other | ) | const |
Not equal operator.
[in] | other | Another FDF document object. This function will check if current object is not equal to this one. |
Assign operator.
[in] | other | Another FDF document object, whose value would be assigned to current object. |
bool foxit::fdf::FDFDoc::operator== | ( | const FDFDoc & | other | ) | const |
Equal operator.
[in] | other | Another FDF document object. This function will check if current object is equal to this one. |
bool foxit::fdf::FDFDoc::SaveAs | ( | const char * | file_path | ) |
Save current document as another FDF or XFDF file.
[in] | file_path | A full path of the new saved FDF or XFDF file. It should not be an empty string. |
bool foxit::fdf::FDFDoc::SaveAs | ( | const wchar_t * | file_path | ) |
Save current document as another FDF or XFDF file.
[in] | file_path | A full path of the new saved FDF or XFDF file. It should not be an empty string. |
bool foxit::fdf::FDFDoc::SaveAs | ( | foxit::common::file::WriterCallback * | file | ) |
Save current document as another FDF or XFDF file.
[in] | file | A common::file::WriterCallback object which is implemented by user to save FDF or XFDF file. |
bool foxit::fdf::FDFDoc::SetPDFPath | ( | const wchar_t * | pdf_path | ) |
Set the path of related PDF document.
[in] | 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. |