Foxit PDF SDK
|
Public Member Functions | |
constructor (document, type) | |
Constructor, with parameters. More... | |
GetObj (number) | |
Get the value (as PDF object) of a specified key integer. More... | |
GetType () | |
Get the type of current number tree. More... | |
HasNumber (number) | |
Check if the specified key integer exists in current number tree. More... | |
IsEmpty () | |
Check whether current object is empty or not. More... | |
RemoveAllObjs () | |
Remove all key integers from current number tree, along with theirs value (as PDF object). More... | |
RemoveObj (number) | |
Remove a key integer from current number tree, along with its value (as PDF object). More... | |
SetObj (number, pdf_object) | |
Set the value (as PDF object) of a specified key integer. If the key integer does not exist, it will be added to current number tree with the value. More... | |
Static Public Attributes | |
static | e_PageLabels |
Enumeration for number tree type. More... | |
Number tree is a kind of common data structure in PDF. A number tree is similar to a number tree, except that keys in a number tree are integers instead of strings and are sorted in ascending numerical order. Number tree has following characteristics:
Class FSDK.PDFNumberTree is used to be associated with an existing number tree with specified type or create one. It offers functions to get key-value pairs in the number tree, and set/add/remove any key-value pair. Currently, class FSDK.PDFNumberTree can be associated with following number tree defined in PDF document:
FSDK.PDFNumberTree.constructor | ( | document | , |
type | |||
) |
Constructor, with parameters.
If there exists number tree with specified type in the PDF document, this function is just to construct a PDF number tree object to be associated with the number tree. If there is no such number tree in PDF document, the constructed PDF number tree object can be used to create such number tree in PDF document and add items to the number tree.
[in] | document | A valid PDF document object. |
[in] | type | The type of the number tree. Please refer to values starting from FSDK.PDFNumberTree.e_PageLabels and this should be one of these values. |
FSDK.PDFNumberTree.GetObj | ( | number | ) |
Get the value (as PDF object) of a specified key integer.
[in] | number | An integer as the key. |
FSDK.PDFNumberTree.GetType | ( | ) |
Get the type of current number tree.
FSDK.PDFNumberTree.HasNumber | ( | number | ) |
Check if the specified key integer exists in current number tree.
[in] | number | An integer that represents the key to be checked. |
FSDK.PDFNumberTree.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
FSDK.PDFNumberTree.RemoveAllObjs | ( | ) |
Remove all key integers from current number tree, along with theirs value (as PDF object).
FSDK.PDFNumberTree.RemoveObj | ( | number | ) |
Remove a key integer from current number tree, along with its value (as PDF object).
If the input key integer does not exist in current number tree, this function will return true directly.
[in] | number | An integer as the key to be removed. |
FSDK.PDFNumberTree.SetObj | ( | number | , |
pdf_object | |||
) |
Set the value (as PDF object) of a specified key integer. If the key integer does not exist, it will be added to current number tree with the value.
[in] | number | An integer as the key. |
[in] | pdf_object | A PDF object to be set as the key's value. It should not be null. The type of this PDF object should match current number tree; otherwise, the input PDF object is invalid. Please refer to comment of class FSDK.PDFNumberTree for more details. User should not release this PDF object after this function succeeds. |
|
static |
Enumeration for number tree type.
Values of this enumeration should be used alone.
"PageLabels" number tree.