|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetElement (key) |
| Get the value element of an entry with specified key. More... | |
| def | GetKey (position) |
| Get the key of an entry specified by position. More... | |
| def | GetValue (position) |
| Get the value element of an entry specified by position. More... | |
| def | HasKey (key) |
| Check whether there is an entry with specified key in current dictionary or not. More... | |
| def | MoveNext (position) |
| Move to the position of first or the next entry. More... | |
| def | RemoveAt (key) |
| Remove an entry specified by key. More... | |
| def | SetAt (key, pdf_object) |
| Set a direct PDF object (whose object number is always equal to 0) as value element to an entry specified by key. More... | |
| def | SetAtBoolean (key, value) |
| Set boolean element an entry specified by key. More... | |
| def | SetAtDateTime (key, value) |
| Set a Datetime object as value element to an entry specified by key. More... | |
| def | SetAtFloat (key, value) |
| Set a float element to an entry specified by key. More... | |
| def | SetAtInteger (key, value) |
| Set a integer element to an entry specified by key. More... | |
| def | SetAtMatrix (key, value) |
| Set a matrix object as value element to an entry specified by key. More... | |
| def | SetAtName (key, value) |
| Set a string (as PDF name object) as value element to an entry specified by key. More... | |
| def | SetAtRect (key, value) |
| Set a rectangle object as value element to an entry specified by key. More... | |
| def | SetAtReference (key, pdf_object, document) |
| Set the reference object of an indirect PDF object (whose object number is always above 0) as value element to an entry specified by key. More... | |
| def | SetAtString (key, value) |
| Set a string as value element to an entry specified by key. More... | |
A PDF dictionary object is an associative table containing pairs of objects, known as entries of the dictionary. The first element of each entry is the key, and it must be a PDF name object. The second element is the value, and it can be any kind of PDF object, including another dictionary. In the same dictionary, no two entries should have the same key. For more details, please refer to Section 3.2.6 "Dictionary Objects" in <PDF Reference 1.7>.
Class fsdk.PDFDictionary is derived from PDFObject and offers functions to create a new PDF dictionary object and get/set entries in a PDF dictionary object.
| def fsdk.PDFDictionary.GetElement | ( | key | ) |
Get the value element of an entry with specified key.
| [in] | key | The key of the entry. It should not be an empty string. |
| def fsdk.PDFDictionary.GetKey | ( | position | ) |
Get the key of an entry specified by position.
| [in] | position | A POSITION that specifies the position of the entry. It should not be null or 0. |
| def fsdk.PDFDictionary.GetValue | ( | position | ) |
Get the value element of an entry specified by position.
| [in] | position | A POSITION that specifies the position of the entry. It should not be null or 0. |
| def fsdk.PDFDictionary.HasKey | ( | key | ) |
Check whether there is an entry with specified key in current dictionary or not.
| [in] | key | The key to be checked. It should not be an empty string. |
| def fsdk.PDFDictionary.MoveNext | ( | position | ) |
Move to the position of first or the next entry.
| [in] | position | A POSITION that indicates the position of current entry in the dictionary. If this is null or 0, the position of first entry in the dictionary will be returned. |
| def fsdk.PDFDictionary.RemoveAt | ( | key | ) |
Remove an entry specified by key.
| [in] | key | The key of the entry to be removed. It should not be an empty string. |
| def fsdk.PDFDictionary.SetAt | ( | key, | |
| pdf_object | |||
| ) |
Set a direct PDF object (whose object number is always equal to 0) as value element to an entry specified by key.
If user wants to set indirect PDF object (whose object number is always above 0) to an entry, please refer to function fsdk.PDFDictionary.SetAtReference .
| [in] | key | The key of the entry, whose value element will be set. It should not be an empty string. |
| [in] | pdf_object | A PDFObject object which is a direct PDF object (whose object number is always equal to 0) and will be set to the entry. It should not be null. |
| def fsdk.PDFDictionary.SetAtBoolean | ( | key, | |
| value | |||
| ) |
Set boolean element an entry specified by key.
| [in] | key | The key of the entry, whose value element will be set. It should not be an empty string. |
| [in] | value | A boolean element which will be set to the entry. |
| def fsdk.PDFDictionary.SetAtDateTime | ( | key, | |
| value | |||
| ) |
Set a Datetime object as value element to an entry specified by key.
| [in] | key | The key of the entry, whose value element will be set. It should not be an empty string. |
| [in] | value | The date time information which will be set to the entry. |
| def fsdk.PDFDictionary.SetAtFloat | ( | key, | |
| value | |||
| ) |
Set a float element to an entry specified by key.
| [in] | key | The key of the entry, whose value element will be set. It should not be an empty string. |
| [in] | value | A float value which will be set to the entry. |
| def fsdk.PDFDictionary.SetAtInteger | ( | key, | |
| value | |||
| ) |
Set a integer element to an entry specified by key.
| [in] | key | The key of the entry, whose value element will be set. It should not be an empty string. |
| [in] | value | An integer value which will be set to the entry. |
| def fsdk.PDFDictionary.SetAtMatrix | ( | key, | |
| value | |||
| ) |
Set a matrix object as value element to an entry specified by key.
| [in] | key | The key of the entry, whose value element will be set. It should not be an empty string. |
| [in] | value | A matrix which will be set to the entry. |
| def fsdk.PDFDictionary.SetAtName | ( | key, | |
| value | |||
| ) |
Set a string (as PDF name object) as value element to an entry specified by key.
| [in] | key | The key of the entry, whose value element will be set. It should not be an empty string. |
| [in] | value | A string which will be set as PDF name object to the entry. It should not be an empty string. |
| def fsdk.PDFDictionary.SetAtRect | ( | key, | |
| value | |||
| ) |
Set a rectangle object as value element to an entry specified by key.
| [in] | key | The key of the entry, whose value element will be set. It should not be an empty string. |
| [in] | value | A rectangle which will be set to the entry. |
| def fsdk.PDFDictionary.SetAtReference | ( | key, | |
| pdf_object, | |||
| document | |||
| ) |
Set the reference object of an indirect PDF object (whose object number is always above 0) as value element to an entry specified by key.
If user wants to set direct PDF object (whose object number is always equal to 0) to an entry, please refer to function fsdk.PDFDictionary.SetAt .
| [in] | key | The key of the entry, whose value element will be set. It should not be an empty string. |
| [in] | pdf_object | A PDFObject object which is an indirect PDF object (whose object number is always above 0) and will be set to the entry by a reference object which refers to this indirect object. It should not be null. |
| [in] | document | A valid PDF document object, to which current PDF dictionary object belongs and in which parameter pdf_object is or will be an indirect object. |
| def fsdk.PDFDictionary.SetAtString | ( | key, | |
| value | |||
| ) |
Set a string as value element to an entry specified by key.
| [in] | key | The key of the entry, whose value element will be set. It should not be an empty string. |
| [in] | value | A wide string which will be set as PDF string object to the entry. |