Foxit PDF SDK
|
Public Types | |
enum | Type { Type.e_Dests = 1, Type.e_JavaScript = 2, Type.e_EmbeddedFiles = 3 } |
Enumeration for name tree type. More... | |
Public Member Functions | |
PDFNameTree (PDFDoc document, PDFNameTree.Type type) | |
Constructor, with parameters. More... | |
PDFNameTree () | |
Constructor. | |
PDFNameTree (PDFNameTree other) | |
Constructor, with another PDF name tree object. More... | |
bool | Add (string name, PDFObject pdf_object) |
Add a new key name with a PDF object as its value. More... | |
int | GetCount () |
Get the count of elements in current name tree. More... | |
string | GetName (int index) |
Get a key name in the name tree, by index. More... | |
PDFObject | GetObj (string name) |
Get the value (as PDF object) of a specified key name. More... | |
PDFNameTree.Type | GetType () |
Get the type of current name tree. More... | |
bool | HasName (string name) |
Check if the specified key name exists in current name tree. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
bool | RemoveAllObjs () |
Remove all key names from current name tree, along with theirs value (as PDF object). More... | |
bool | RemoveObj (string name) |
Remove a key name from current name tree, along with its value (as PDF object). More... | |
bool | Rename (string old_name, string new_name) |
Rename an existing key name to a new key name. More... | |
bool | SetObj (string name, PDFObject pdf_object) |
Set the value (as PDF object) of a specified key name. More... | |
Name tree is a kind of common data structure in PDF. Name tree serves a similar purpose to PDF dictionary
|
strong |
|
inline |
Constructor, with parameters.
If there exists name tree with specified type in the PDF document, this function is just to construct a PDF name tree object to be associated with the name tree. If there is no such name tree in PDF document, the constructed PDF name tree object can be used to create such name tree in PDF document and add items to the name tree.
[in] | document | A valid PDF document object. |
[in] | type | The type of the name tree. Please refer to values starting from foxit.pdf.objects.PDFNameTree.Type.e_Dests and this should be one of these values. |
|
inline |
Constructor, with another PDF name tree object.
[in] | other | Another PDF name tree object. |
|
inline |
Add a new key name with a PDF object as its value.
All PDF objects in the name tree are ordered by their names. When a new PDF object is added, Foxit PDF SDK will find a suitable place in the name tree to add it. After adding successfully, the indexes of some old keys may be changed.
[in] | name | String for a new key name. This should not be an empty string. This new name should not have existed in current name tree. |
[in] | pdf_object | A PDF object, to be set with the new name. The type of this PDF object should match current name tree; otherwise, the input PDF object is invalid. Please refer to comment of class PDFNameTree for more details. User should not release this PDF object after this function succeeds. |
|
inline |
Get the count of elements in current name tree.
|
inline |
Get a key name in the name tree, by index.
[in] | index | Index of the key name to be retrieved. Valid range: from 0 to (count-1). count is returned by function PDFNameTree.GetCount . |
|
inline |
Get the value (as PDF object) of a specified key name.
[in] | name | String for a key name. It should not be an empty string. |
|
inline |
Get the type of current name tree.
|
inline |
Check if the specified key name exists in current name tree.
[in] | name | A string that represents the key name to be checked. It should not be an empty string. |
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
Remove all key names from current name tree, along with theirs value (as PDF object).
|
inline |
Remove a key name from current name tree, along with its value (as PDF object).
If the input name does not exist in current name tree, this function will return true directly.
[in] | name | String for a key name to be removed. This should not be an empty string. |
|
inline |
Rename an existing key name to a new key name.
[in] | old_name | String for an old key name which is to be renamed. This should not be an empty string. This name should have existed in current name tree. |
[in] | new_name | String for a new key name. This should not be an empty string. This new name should not have existed in current name tree. |
|
inline |
Set the value (as PDF object) of a specified key name.
[in] | name | String for a key name. It should not be an empty string. This name should have existed in current name tree. |
[in] | pdf_object | A PDF object to be set as the name's value. It should not be null. The type of this PDF object should match current name tree; otherwise, the input PDF object is invalid. Please refer to comment of class PDFNameTree for more details. User should not release this PDF object after this function succeeds. |