|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetCatalog () |
| Get the catalog dictionary. More... | |
| def | GetFDFDict () |
| Get the dictionary of "FDF" entry from catalog dictionary. More... | |
| def | GetPDFPath () |
| Get the path of related PDF document. More... | |
| def | GetType () |
| Get the type of current document object. More... | |
| def | IsEmpty () |
| Check whether current object is empty or not. More... | |
| def | SaveAs (file) |
| Save current document as another FDF or XFDF file. More... | |
| def | SaveAs (file_path) |
| Save current document as another FDF or XFDF file. More... | |
| def | SetPDFPath (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 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 fsdk.FileReaderCallback 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 fsdk.PDFDoc.ImportFromFDF , fsdk.PDFDoc.ExportToFDF and fsdk.PDFDoc.ExportAnnotToFDF .
| def fsdk.FDFDoc.GetCatalog | ( | ) |
Get the catalog dictionary.
| def fsdk.FDFDoc.GetFDFDict | ( | ) |
Get the dictionary of "FDF" entry from catalog dictionary.
| def fsdk.FDFDoc.GetPDFPath | ( | ) |
Get the path of related PDF document.
The path can be either an absolute one, or a relative one.
| def fsdk.FDFDoc.GetType | ( | ) |
Get the type of current document object.
| def fsdk.FDFDoc.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
| def fsdk.FDFDoc.SaveAs | ( | file | ) |
Save current document as another FDF or XFDF file.
| [in] | file | A fsdk.FileWriterCallback object which is implemented by user to save FDF or XFDF file. |
| def fsdk.FDFDoc.SaveAs | ( | 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. |
| def fsdk.FDFDoc.SetPDFPath | ( | 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. |