Foxit PDF SDK

Public Member Functions | Static Public Attributes | List of all members
FSDK.FDFDoc Class Reference

## Public Member Functions
| constructor (file_read)
| Constructor, with a file read callback object. More...
| constructor (type)
| Constructor. More...
| constructor (path)
| Constructor, from an existing FDF or XFDF file path. More...
| constructor (buffer, length)
| Constructor, from a memory buffer. More...
| GetCatalog ()
| Get the catalog dictionary. More...
| GetFDFDict ()
| Get the dictionary of "FDF" entry from catalog dictionary. More...
| GetPDFPath ()
| Get the path of related PDF document. More...
| GetType ()
| Get the type of current document object. More...
| IsEmpty ()
| Check whether current object is empty or not. More...
| SaveAs (file_path)
| Save current document as another FDF or XFDF file. More...
| SaveAs (file)
| Save current document as another FDF or XFDF file. More...
| SetPDFPath (pdf_path)
| Set the path of related PDF document. More...

## Static Public Attributes
static | e_FDF
| Enumeration for FDF document type. More...
static | e_XFDF
| FDF document type: XFDF.

## Detailed Description

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 FSDK.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.

See also
  FSDK.PDFDoc

## Member Function Documentation

## ◆ constructor() [1/4]

FSDK.FDFDoc.constructor | ( | file_read |  | ) |

Constructor, with a file read callback object.

Parameters

  [in] | file_read | Pointer to a FSDK.FileReaderCallback object which is implemented by user to load a FDF or XFDF document. It should not be null.

## ◆ constructor() [2/4]

FSDK.FDFDoc.constructor | ( | type |  | ) |

Constructor.

This constructor is to construct a new FDF document object (without any data).

Parameters

  [in] | type | FDF document type. It should be one of following values: FSDK.FDFDoc.e_FDF, FSDK.FDFDoc.e_XFDF

## ◆ constructor() [3/4]

FSDK.FDFDoc.constructor | ( | path |  | ) |

Constructor, from an existing FDF or XFDF file path.

Parameters

  [in] | path | A full path of an existing FDF/XFDF file. It should not be an empty string.

## ◆ constructor() [4/4]

FSDK.FDFDoc.constructor | ( | buffer | ,
|  | length |
| ) |  |

Constructor, from a memory buffer.

Parameters

  [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.

## ◆ GetCatalog()

FSDK.FDFDoc.GetCatalog | ( |  | ) |

Get the catalog dictionary.

Returns
  The catalog dictionary. If current object represents an XFDF document, this function will return null.

## ◆ GetFDFDict()

FSDK.FDFDoc.GetFDFDict | ( |  | ) |

Get the dictionary of "FDF" entry from catalog dictionary.

Returns
  The dictionary of "FDF" entry from catalog dictionary. If current object represents an XFDF document, this function will return null.

## ◆ GetPDFPath()

FSDK.FDFDoc.GetPDFPath | ( |  | ) |

Get the path of related PDF document.

The path can be either an absolute one, or a relative one.

Returns
  File path of related PDF document. Empty string means no such information is found.

## ◆ GetType()

FSDK.FDFDoc.GetType | ( |  | ) |

Get the type of current document object.

Returns
  FDF document type. It would be one of following values:
  FSDK.FDFDoc.e_FDF, FSDK.FDFDoc.e_XFDF.

## ◆ IsEmpty()

FSDK.FDFDoc.IsEmpty | ( |  | ) |

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
  true means current object is empty, while false means not.

## ◆ SaveAs() [1/2]

FSDK.FDFDoc.SaveAs | ( | file_path |  | ) |

Save current document as another FDF or XFDF file.

Parameters

  [in] | file_path | A full path of the new saved FDF or XFDF file. It should not be an empty string.

Returns
  true means success, while false means failure.

Note
  This function does not support to save current FDF object just back to the FDF or XFDF file which is used to construct current FDF object. In order to do so, user is recommended to do as following steps:
  Assume that current FDF object is constructed from a FDF file named "org.fdf".
  1. Use current function to save current FDF object to a temporary file. Here, this temporary file is named as "temp.tmp".
  2. Ensure that current FDF object has destructed.
  3. Remove "org.fdf" and rename "temp.tmp" to "org.fdf".

## ◆ SaveAs() [2/2]

FSDK.FDFDoc.SaveAs | ( | file |  | ) |

Save current document as another FDF or XFDF file.

Parameters

  [in] | file | A FSDK.FileWriterCallback object which is implemented by user to save FDF or XFDF file.

Returns
  true means success, while false means failure.

Note
  This function does not support to save current FDF object just back to the FDF or XFDF file which is used to construct current FDF object. In order to do so, user is recommended to do as following steps:
  Assume that current FDF object is constructed from a FDF file named "org.fdf".
  1. Use current function to save current FDF object to an temporary file. Here, this temporary file is named as "temp.tmp".
  2. Ensure that current FDF object has destructed.
  3. Remove "org.fdf" and rename "temp.tmp" to "org.fdf".

## ◆ SetPDFPath()

FSDK.FDFDoc.SetPDFPath | ( | pdf_path |  | ) |

Set the path of related PDF document.

Parameters

  [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.

Returns
  true means success, while false means failure.

## Member Data Documentation

## ◆ e_FDF

FSDK.FDFDoc.e_FDF
| static

Enumeration for FDF document type.

Values of this enumeration should be used alone.FDF document type: FDF.