|
Foxit PDF SDK
|
Public Member Functions | |
| def | CloneObject () |
| Clone current PDF object and get the cloned PDF object. More... | |
| def | DeepCloneObject () |
| Clone current PDF object and get the cloned PDF object. More... | |
| def | GetArray () |
| Get the PDF array object of current PDF object. More... | |
| def | GetBoolean () |
| Get the boolean value of current PDF object. More... | |
| def | GetDateTime () |
| Get the date time value of current PDF object. More... | |
| def | GetDict () |
| Get the PDF dictionary object of current PDF object. More... | |
| def | GetDirectObject () |
| Get the direct object of current PDF object. More... | |
| def | GetFloat () |
| Get the float value of current PDF object. More... | |
| def | GetInteger () |
| Get the integer value of current PDF object. More... | |
| def | GetMatrix () |
| Get the matrix value of current PDF object. More... | |
| def | GetName () |
| Get the name value of current PDF object. More... | |
| def | GetObjNum () |
| Get the indirect object number of current PDF object. More... | |
| def | GetRect () |
| Get the rectangle value of current PDF object. More... | |
| def | GetStream () |
| Get the PDF stream object of current PDF object. More... | |
| def | GetString () |
| Get the string value of current PDF object. More... | |
| def | GetType () |
| Get the type of current PDF object. More... | |
| def | GetWideString () |
| Get the wide string value of current PDF object. More... | |
| def | IsIdentical (pdf_obj) |
| Check if input PDF object is identical with current PDF object. More... | |
| def | Release () |
| Release a newly created PDF object or a clone PDF object, which is not related to PDF document or other PDF object and will not be used any more. More... | |
PDF supports eight basic types of objects:
"Boolean value", "Integer and real number", "String", "Name", "Array", "Dictionary", "Stream", "The null
object". For more details about PDF objects, please refer to Section 3.2 "Objects" in <PDF Reference 1.7>.
Class PDFObject is a base class for all kinds of PDF objects. It offers different functions to create different kind of PDF objects. For "Array", "Dictionary" and "Stream" PDF object, please refer to derived classes fsdk.PDFArray , fsdk.PDFDictionary and PDFStream .
If user wants to make a newly created PDF object to be an indirect object, please call function fsdk.PDFDoc.AddIndirectObject .
| def fsdk.PDFObject.CloneObject | ( | ) |
Clone current PDF object and get the cloned PDF object.
Please call fsdk.PDFObject.Release to release the new object if it has not been added/set into PDF document or other PDF object and will not be used any more.
| def fsdk.PDFObject.DeepCloneObject | ( | ) |
Clone current PDF object and get the cloned PDF object.
This function is a totally direct copy, without any reference object inside, so the copy object can be copied to another document. Please call fsdk.PDFObject.Release to release the new object if it has not been added/set into PDF document or other PDF object and will not be used any more.
| def fsdk.PDFObject.GetArray | ( | ) |
Get the PDF array object of current PDF object.
If the type of current PDF object is fsdk.PDFObjectE_Reference , this function will check the direct PDF object of current PDF object.
| def fsdk.PDFObject.GetBoolean | ( | ) |
Get the boolean value of current PDF object.
Only useful when the type of current PDF object is fsdk.PDFObjectE_Boolean .
| def fsdk.PDFObject.GetDateTime | ( | ) |
Get the date time value of current PDF object.
Only useful when the type of current PDF objec is fsdk.PDFObjectE_String and its content is in PDF standard date format.
| def fsdk.PDFObject.GetDict | ( | ) |
Get the PDF dictionary object of current PDF object.
If the type of current PDF object is fsdk.PDFObjectE_Reference , this function will check the direct PDF object of current PDF object.
| def fsdk.PDFObject.GetDirectObject | ( | ) |
Get the direct object of current PDF object.
If the type of current PDF object is fsdk.PDFObjectE_Reference , the direct object will be returned.
| def fsdk.PDFObject.GetFloat | ( | ) |
Get the float value of current PDF object.
Only useful when the type of current PDF object is fsdk.PDFObjectE_Number .
| def fsdk.PDFObject.GetInteger | ( | ) |
Get the integer value of current PDF object.
Only useful when the type of current PDF object is fsdk.PDFObjectE_Number .
| def fsdk.PDFObject.GetMatrix | ( | ) |
Get the matrix value of current PDF object.
Only useful for PDF object whose type is fsdk.PDFObjectE_Array and it has 6 number objects as elements.
| def fsdk.PDFObject.GetName | ( | ) |
Get the name value of current PDF object.
Only useful when the type of current PDF object is fsdk.PDFObjectE_Name or fsdk.PDFObjectE_String .
| def fsdk.PDFObject.GetObjNum | ( | ) |
Get the indirect object number of current PDF object.
| def fsdk.PDFObject.GetRect | ( | ) |
Get the rectangle value of current PDF object.
Only useful for PDF object whose type is fsdk.PDFObjectE_Array and it has 4 number objects as elements.
| def fsdk.PDFObject.GetStream | ( | ) |
Get the PDF stream object of current PDF object.
If the type of current PDF object is fsdk.PDFObjectE_Reference , this function will check the direct PDF object of current PDF object.
| def fsdk.PDFObject.GetString | ( | ) |
Get the string value of current PDF object.
This function will get the string format for actual value of current PDF object:
If value of current PDF object cannot be converted to a valid string, an empty string will be returned.
| def fsdk.PDFObject.GetType | ( | ) |
Get the type of current PDF object.
| def fsdk.PDFObject.GetWideString | ( | ) |
Get the wide string value of current PDF object.
This function will get the string format for actual value of current PDF object:
If value of current PDF object cannot be converted to a valid string, an empty string will be returned.
| def fsdk.PDFObject.IsIdentical | ( | pdf_obj | ) |
Check if input PDF object is identical with current PDF object.
| [in] | pdf_obj | Another PDF object which is to be check with current PDF object. |
| def fsdk.PDFObject.Release | ( | ) |
Release a newly created PDF object or a clone PDF object, which is not related to PDF document or other PDF object and will not be used any more.
This function should be called only for a newly created PDF object or a cloned PDF object, which has not been added or set to other PDF object or related to PDF document, and will not be used any more. Please do not use this function for other case, otherwise unknown error may occur.