Foxit PDF SDK
|
Public Member Functions | |
FileSpec (PDFDoc document) | |
Constructor. More... | |
FileSpec (PDFDoc document, PDFObject pdf_object) | |
Constructor, from an existing file specification PDF object in a PDF document. More... | |
FileSpec (FileSpec other) | |
Constructor, with another file specification object. More... | |
bool | Embed (string file_path) |
Embed the whole content of a file which is specified by file path. More... | |
bool | Embed (PDFObject 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... | |
bool | Embed (StreamCallback stream) |
Embed a file by using foxit.common.fxcrt.StreamCallback . More... | |
bool | ExportToFile (string path) |
Export the file data that represented in current file specification directly into a file. More... | |
bool | ExportToFileStream (StreamCallback stream) |
Export the file data that represented in current file specification through a stream callback object. More... | |
AssociatedFiles.Relationship | GetAssociteFileRelationship () |
(Only supported in PDF 2.0) Get the associated file relationship when current file specification is used as an associated file. More... | |
string | GetChecksum () |
Get the checksum for embedded file. More... | |
DateTime | GetCreationDateTime () |
Get creation date and time about when the embedded file was created. More... | |
string | GetDescription () |
Get the descriptive text associated with current file specification. More... | |
PDFDictionary | GetDict () |
Get the PDF dictionary of current file specification. More... | |
FileReaderCallback | GetFileData () |
Get the file data of embedded file. More... | |
string | GetFileName () |
Get the file name. More... | |
long | GetFileSize () |
Get the size of embedded file. More... | |
DateTime | GetModifiedDateTime () |
Get modified date and time about when the embedded file was last modified. More... | |
string | 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... | |
bool | IsEmbedded () |
Check whether current file specification object represents an embedded file or not. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
void | SetAssociteFileRelationship (AssociatedFiles.Relationship associfile_relationship) |
(Only supported in PDF 2.0) Set the associated file relationship when current file specification is used as an associated file. More... | |
void | SetChecksum (byte[] checksum) |
Set the checksum for embedded file. (Not affect local file) More... | |
void | SetCreationDateTime (DateTime date_time) |
Set the creation date and time for the embedded file. (Not affect local file) More... | |
void | SetDescription (string description) |
Set the descriptive text associated with current file specification. More... | |
void | SetFileName (string file_name) |
Set the file name. More... | |
void | SetModifiedDateTime (DateTime date_time) |
Set last modified date and time for the embedded file. (Not affect local file) More... | |
void | SetSubtype (string 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... | |
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.
|
inline |
Constructor.
This constructor is to construct a new file specification object (without any data).
[in] | document | A valid PDF document object, to which the new file specification object will belongs. |
Constructor, from an existing file specification PDF object in a PDF document.
[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:
|
|
inline |
Constructor, with another file specification object.
[in] | other | Another file specification object. |
|
inline |
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.
[in] | file_path | A full path of an existing local file. |
|
inline |
(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.
[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. |
|
inline |
Embed a file by using foxit.common.fxcrt.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.
[in] | stream | A foxit.common.fxcrt.StreamCallback object which is implemented by user to read the file content. |
|
inline |
Export the file data that represented in current file specification directly into a file.
[in] | path | A full path of a file to which the data will be saved. |
|
inline |
Export the file data that represented in current file specification through a stream callback object.
[in] | stream | A foxit.common.fxcrt.StreamCallback object which is implemented by user to save the file data. |
|
inline |
(Only supported in PDF 2.0) Get the associated file relationship when current file specification is used as an associated file.
|
inline |
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.
|
inline |
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.
|
inline |
Get the descriptive text associated with current file specification.
|
inline |
Get the PDF dictionary of current file specification.
|
inline |
Get the file data of embedded file.
|
inline |
Get the file name.
|
inline |
Get the 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.
|
inline |
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.
|
inline |
(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.
|
inline |
Check whether current file specification object represents an embedded file or not.
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
(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.
[in] | associfile_relationship | The associated file relationship to be set. Please refer to values starting from foxit.pdf.AssociatedFiles.Relationship.e_RelationshipSource and this would be one of these values. |
|
inline |
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.
[in] | checksum | A checksum to be set. |
|
inline |
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.
[in] | date_time | The creation date and time to be set. |
|
inline |
Set the descriptive text associated with current file specification.
[in] | description | A descriptive text to be set. It should not be an empty string. |
|
inline |
Set the file name.
This function is required for a new file specification object (not constructed from an existing file specification PDF object).
[in] | file_name | The file name to be set. It should not be an empty string. |
|
inline |
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.
[in] | date_time | The last modified date and time to be set. |
|
inline |
(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.
[in] | subtype | A valid MIME type value. |