Foxit PDF SDK
|
Public Member Functions | |
def | FDFDoc (buffer, length) |
Constructor, from a memory buffer. More... | |
def | FDFDoc (file_read) |
Constructor, with a file read callback object. More... | |
def | FDFDoc (other) |
Constructor, with another FDF document object. More... | |
def | FDFDoc (path) |
Constructor, from an existing FDF or XFDF file path. More... | |
def | FDFDoc (type) |
Constructor. More... | |
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... | |
Static Public Attributes | |
e_FDF = _fsdk.FDFDoc_e_FDF | |
FDF document type: FDF. | |
e_XFDF = _fsdk.FDFDoc_e_XFDF | |
FDF document type: XFDF. | |
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 FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.PDFDoc.ImportFromFDF , FoxitPDFSDKPython2.PDFDoc.ExportToFDF and FoxitPDFSDKPython2.PDFDoc.ExportAnnotToFDF .
def FoxitPDFSDKPython2.FDFDoc.FDFDoc | ( | file_read | ) |
Constructor, with a file read callback object.
[in] | file_read | Pointer to a FoxitPDFSDKPython2.FileReaderCallback object which is implemented by user to load a FDF or XFDF document. It should not be null. |
def FoxitPDFSDKPython2.FDFDoc.FDFDoc | ( | type | ) |
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: FoxitPDFSDKPython2.FDFDoc.e_FDF , FoxitPDFSDKPython2.FDFDoc.e_XFDF |
def FoxitPDFSDKPython2.FDFDoc.FDFDoc | ( | path | ) |
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. |
def FoxitPDFSDKPython2.FDFDoc.FDFDoc | ( | buffer, | |
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. |
def FoxitPDFSDKPython2.FDFDoc.FDFDoc | ( | other | ) |
Constructor, with another FDF document object.
[in] | other | Another FDF document object. |
def FoxitPDFSDKPython2.FDFDoc.GetCatalog | ( | ) |
Get the catalog dictionary.
def FoxitPDFSDKPython2.FDFDoc.GetFDFDict | ( | ) |
Get the dictionary of "FDF" entry from catalog dictionary.
def FoxitPDFSDKPython2.FDFDoc.GetPDFPath | ( | ) |
Get the path of related PDF document.
The path can be either an absolute one, or a relative one.
def FoxitPDFSDKPython2.FDFDoc.GetType | ( | ) |
Get the type of current document object.
def FoxitPDFSDKPython2.FDFDoc.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
def FoxitPDFSDKPython2.FDFDoc.SaveAs | ( | file | ) |
Save current document as another FDF or XFDF file.
[in] | file | A FoxitPDFSDKPython2.FileWriterCallback object which is implemented by user to save FDF or XFDF file. |
def FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.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. |