Foxit PDF SDK

Public Member Functions | List of all members
FSDK.FileSpec Class Reference

## Public Member Functions
| FileSpec (document)
| Constructor. More...
| FileSpec (document, pdf_object)
| Constructor, from an existing file specification PDF object in a PDF document. More...
| Embed (file_path)
| Embed the whole content of a file which is specified by file path. More...
| Embed (pdf_object)
| (Only support in PDF 2.0) Embed the whole content of a PDF stream object or a PDF reference object which refers to a PDF stream object, when current file specification object is used as an associated file. More...
| Embed (stream)
| Embed a file by using FSDK.StreamCallback. More...
| ExportToFile (path)
| Export the file data that represented in current file specification directly into a file. More...
| ExportToFileStream (stream)
| Export the file data that represented in current file specification through a stream callback object. More...
| GetAssociteFileRelationship ()
| (Only supported in PDF 2.0) Get the associated file relationship when current file specification is used as an associated file. More...
| GetChecksum ()
| Get the checksum for embedded file. More...
| GetCompressedEmbeddedFileSize ()
| Get the compressed file size of embedded file. More...
| GetCreationDateTime ()
| Get creation date and time about when the embedded file was created. More...
| GetDescription ()
| Get the descriptive text associated with current file specification. More...
| GetDict ()
| Get the PDF dictionary of current file specification. More...
| GetFileData ()
| Get the file data of embedded file. More...
| GetFileName ()
| Get the file name. More...
| GetFileSize ()
| Get the size of embedded file (uncompressed file size). More...
| GetModifiedDateTime ()
| Get modified date and time about when the embedded file was last modified. More...
| GetSubtype ()
| (Only support in PDF 2.0) Get the MIME type value for "Subtype" key for embedded file when current file specification is used as an associated file. More...
| IsEmbedded ()
| Check whether current file specification object represents an embedded file or not. More...
| IsEmpty ()
| Check whether current object is empty or not. More...
| SetAssociteFileRelationship (associfile_relationship)
| (Only supported in PDF 2.0) Set the associated file relationship when current file specification is used as an associated file. More...
| SetChecksum (checksum)
| Set the checksum for embedded file. (Not affect local file) More...
| SetCreationDateTime (date_time)
| Set the creation date and time for the embedded file. (Not affect local file) More...
| SetDescription (description)
| Set the descriptive text associated with current file specification. More...
| SetFileName (file_name)
| Set the file name. More...
| SetModifiedDateTime (date_time)
| Set last modified date and time for the embedded file. (Not affect local file) More...
| SetSubtype (subtype)
| (Only support in PDF 2.0) Set the MIME type value for "Subtype" key for embedded file (Not affect local file) when current file specification is used as an associated file. More...

## Detailed Description

A PDF file can refer to the contents of another file by using a file specification. File specification can simply represents the file path of another file, or represents the whole content of another file, which is embedded to current PDF file.

## Constructor & Destructor Documentation

## ◆ FileSpec() [1/2]

FSDK.FileSpec.FileSpec | ( | document |  | ) |

Constructor.

This constructor is to construct a new file specification object (without any data).

Parameters

  [in] | document | A valid PDF document object, to which the new file specification object will belongs.

## ◆ FileSpec() [2/2]

FSDK.FileSpec.FileSpec | ( | document | ,
|  | pdf_object |
| ) |  |

Constructor, from an existing file specification PDF object in a PDF document.

Parameters

  [in] | document | A valid PDF document object, to which the file specification PDF object belongs.
  [in] | pdf_object | A valid PDF object which represents an existing file specification object in the PDF document. It should be either a dictionary object or a PDF reference object: If it is a PDF dictionary object, it should be a file specification dictionary. If it is a PDF reference object, it should refer to a file specification dictionary. This PDF object can be retrieved from FSDK.PDFNameTree in type FSDK.PDFNameTree.e_EmbeddedFiles.

## Member Function Documentation

## ◆ Embed() [1/3]

FSDK.FileSpec.Embed | ( | file_path |  | ) |

Embed the whole content of a file which is specified by file path.

When this function succeeds, the whole content of specified file will be embedded to the PDF document that current file specification belongs to.

Parameters

  [in] | file_path | A full path of an existing local file.

Returns
  true means success, while false means failure.

## ◆ Embed() [2/3]

FSDK.FileSpec.Embed | ( | pdf_object |  | ) |

(Only support in PDF 2.0) Embed the whole content of a PDF stream object or a PDF reference object which refers to a PDF stream object, when current file specification object is used as an associated file.

When this function succeeds, the whole content of specified PDF stream object will be embedded to the PDF document that current file specification belongs to.

Parameters

  [in] | pdf_object | A valid PDF object. It should be either a PDF stream object or a PDF reference object which refers to a PDF stream object.

Returns
  true means success, while false means failure.

## ◆ Embed() [3/3]

FSDK.FileSpec.Embed | ( | stream |  | ) |

Embed a file by using FSDK.StreamCallback.

When this function succeeds, please keep input stream callback object valid until the PDF file (which current file specification belongs to) is saved or closed.

Parameters

  [in] | stream | A FSDK.StreamCallback object which is implemented by user to read the file content.

Returns
  true means success, while false means failure.

## ◆ ExportToFile()

FSDK.FileSpec.ExportToFile | ( | path |  | ) |

Export the file data that represented in current file specification directly into a file.

Parameters

  [in] | path | A full path of a file to which the data will be saved.

Returns
  true means success, while false means failure.

## ◆ ExportToFileStream()

FSDK.FileSpec.ExportToFileStream | ( | stream |  | ) |

Export the file data that represented in current file specification through a stream callback object.

Parameters

  [in] | stream | A FSDK.StreamCallback object which is implemented by user to save the file data.

Returns
  true means success, while false means failure.

## ◆ GetAssociteFileRelationship()

FSDK.FileSpec.GetAssociteFileRelationship | ( |  | ) |

(Only supported in PDF 2.0) Get the associated file relationship when current file specification is used as an associated file.

Returns
  The associated file relationship. Please refer to values starting from FSDK.AssociatedFiles.e_RelationshipSource and this should be one of these values.

## ◆ GetChecksum()

FSDK.FileSpec.GetChecksum | ( |  | ) |

Get the checksum for embedded file.

This function is only useful when current file specification object represents an embedded file. A 16-byte string that is the checksum of the bytes of the uncompressed embedded file. The checksum is calculated by applying the standard MD5 message-digest algorithm to the bytes of the embedded file stream.
If current file specification object does not represent an embedded file, this function will return an empty string.

Returns
  The checksum string.

## ◆ GetCompressedEmbeddedFileSize()

FSDK.FileSpec.GetCompressedEmbeddedFileSize | ( |  | ) |

Get the compressed file size of embedded file.

This function is only useful when current file specification object represents an embedded file. If current file specification object does not represent an embedded file, this function will return 0 directly.

Returns
  Compressied file size of embedded file.

## ◆ GetCreationDateTime()

FSDK.FileSpec.GetCreationDateTime | ( |  | ) |

Get creation date and time about when the embedded file was created.

This function is only useful when current file specification object represents an embedded file. If current file specification object does not represent an embedded file, this function will return a date and time object will all value 0.

Returns
  The creation date time of embedded file.

## ◆ GetDescription()

FSDK.FileSpec.GetDescription | ( |  | ) |

Get the descriptive text associated with current file specification.

Returns
  The descriptive text.

## ◆ GetDict()

FSDK.FileSpec.GetDict | ( |  | ) |

Get the PDF dictionary of current file specification.

Returns
  A PDF dictionary object. If there is any error, this function will return null.

## ◆ GetFileData()

FSDK.FileSpec.GetFileData | ( |  | ) |

Get the file data of embedded file.

Returns
  A FSDK.FileReaderCallback object. User can call functions in class FSDK.FileReaderCallback to read the file data.

## ◆ GetFileName()

FSDK.FileSpec.GetFileName | ( |  | ) |

Get the file name.

Returns
  The file name. If no file name can be found, this function will return an empty string.

## ◆ GetFileSize()

FSDK.FileSpec.GetFileSize | ( |  | ) |

Get the size of embedded file (uncompressed file size).

This function is only useful when current file specification object represents an embedded file. If current file specification object does not represent an embedded file, this function will return 0 directly.

Returns
  File size of embedded file (uncompressed file size).

## ◆ GetModifiedDateTime()

FSDK.FileSpec.GetModifiedDateTime | ( |  | ) |

Get modified date and time about when the embedded file was last modified.

This function is only useful when current file specification object represents an embedded file. If current file specification object does not represent an embedded file, this function will return a date and time object will all value 0.

Returns
  The modified date time of embedded file.

## ◆ GetSubtype()

FSDK.FileSpec.GetSubtype | ( |  | ) |

(Only support in PDF 2.0) Get the MIME type value for "Subtype" key for embedded file when current file specification is used as an associated file.

This function is only useful when current file specification object represents an embedded file and used as associated file.

Returns
  The subtype string.

## ◆ IsEmbedded()

FSDK.FileSpec.IsEmbedded | ( |  | ) |

Check whether current file specification object represents an embedded file or not.

Returns
  true means current file specification object represents an embedded file. false means current file specification object does not represent an embedded file.

## ◆ IsEmpty()

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

## ◆ SetAssociteFileRelationship()

FSDK.FileSpec.SetAssociteFileRelationship | ( | associfile_relationship |  | ) |

(Only supported in PDF 2.0) Set the associated file relationship when current file specification is used as an associated file.

This function is required for a newly created associated file specification object.

Parameters

  [in] | associfile_relationship | The associated file relationship to be set. Please refer to values starting from FSDK.AssociatedFiles.e_RelationshipSource and this would be one of these values.

Returns
  None.

## ◆ SetChecksum()

FSDK.FileSpec.SetChecksum | ( | checksum |  | ) |

Set the checksum for embedded file. (Not affect local file)

This function is only useful if current file specification object represents an embedded file.
A 16-byte string that is the checksum of the bytes of the uncompressed embedded file. The checksum is calculated by applying the standard MD5 message-digest algorithm to the bytes of the embedded file stream.

Parameters

  [in] | checksum | A checksum to be set.

Returns
  None.

## ◆ SetCreationDateTime()

FSDK.FileSpec.SetCreationDateTime | ( | date_time |  | ) |

Set the creation date and time for the embedded file. (Not affect local file)

This function is only useful when current file specification object represents an embedded file.

Parameters

  [in] | date_time | The creation date and time to be set.

Returns
  None.

## ◆ SetDescription()

FSDK.FileSpec.SetDescription | ( | description |  | ) |

Set the descriptive text associated with current file specification.

Parameters

  [in] | description | A descriptive text to be set. It should not be an empty string.

Returns
  None.

## ◆ SetFileName()

FSDK.FileSpec.SetFileName | ( | file_name |  | ) |

Set the file name.

This function is required for a new file specification object (not constructed from an existing file specification PDF object).

Parameters

  [in] | file_name | The file name to be set. It should not be an empty string.

Returns
  None.

## ◆ SetModifiedDateTime()

FSDK.FileSpec.SetModifiedDateTime | ( | date_time |  | ) |

Set last modified date and time for the embedded file. (Not affect local file)

This function is only useful when current file specification object represents an embedded file.

Parameters

  [in] | date_time | The last modified date and time to be set.

Returns
  None.

## ◆ SetSubtype()

FSDK.FileSpec.SetSubtype | ( | subtype |  | ) |

(Only support in PDF 2.0) Set the MIME type value for "Subtype" key for embedded file (Not affect local file) when current file specification is used as an associated file.

This function is only useful when current file specification object represents an embedded file and used as associated file.

Parameters

  [in] | subtype | A valid MIME type value. Default value: "application/octet-stream".

Returns
  None.