Foxit PDF SDK
|
Public Member Functions | |
constructor (document) | |
Constructor, from a PDF document. More... | |
GetDict () | |
Get the dictionary of current object. More... | |
GetOCGs () | |
Get the "OCGs" PDF array from current object. More... | |
GetRootNode () | |
Get the root layer node. More... | |
IsEmpty () | |
Check whether current object is empty or not. More... | |
SetBaseState (state) | |
Set the base state for all layers in the default configuration. More... | |
Static Public Attributes | |
static | e_StateOFF |
The state is OFF. | |
static | e_StateON |
Enumeration for PDF layer base state. More... | |
static | e_StateUnchanged |
The state is unchanged. | |
static | e_StateUndefined |
The state is undefined. | |
PDF layer nodes are stored in a PDF layer tree. If user wants to retrieve a layer node, user must construct a layer tree object from a PDF document first and then call function FSDK.LayerTree.GetRootNode to get the root layer node of the whole layer tree. Then, user can enumerate all the nodes in the layer tree from the root layer node.
FSDK.LayerTree.constructor | ( | document | ) |
Constructor, from a PDF document.
The constructed layer tree object can be associated with existed layer tree in PDF document. If there is no layer tree in PDF document which can be judged by functoin FSDK.PDFDoc.HasLayer, the constructed layer tree object will build layer related dictionary.
[in] | document | A valid PDF document object. |
FSDK.LayerTree.GetDict | ( | ) |
Get the dictionary of current object.
FSDK.LayerTree.GetOCGs | ( | ) |
Get the "OCGs" PDF array from current object.
FSDK.LayerTree.GetRootNode | ( | ) |
Get the root layer node.
After getting the root layer node, user can enumerate all layer nodes in current layer tree by functions of class LayerNode.
FSDK.LayerTree.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
FSDK.LayerTree.SetBaseState | ( | state | ) |
Set the base state for all layers in the default configuration.
If user wants the new state to have effect on rendering result, please construct a new layer context object after this function succeeds, and then use the new LayerContext to Renderer to do rendering.
[in] | state | Layer usage state. Please refer to values starting from FSDK.LayerTree.e_StateON and this should be one of these values except FSDK.LayerTree.e_StateUndefined. |
|
static |
Enumeration for PDF layer base state.
Values of this enumeration should be used alone.
The state is ON.