This class represents a layer context for rendering. If user wants to render layers, please construct a layer context object first and then set it to a foxit.common.Renderer object by function common.Renderer.SetLayerContext .
- See Also
- foxit.common.Renderer
Enumeration for PDF layer usage type.
Values of this enumeration should be used alone.
Enumerator |
---|
e_UsageView |
Use for a viewer.
|
e_UsageDesign |
Use for representing a document designer's structural organization of artwork.
|
e_UsagePrint |
Use for printing.
|
e_UsageExport |
Use for exporting.
|
e_UsageZoom |
Use for zooming.
|
Constructor, based on a PDF document and specified layer usage type.
- Parameters
-
Constructor, with another layer context object.
- Parameters
-
[in] | other | Another layer context object. |
bool foxit.pdf.LayerContext.CopyStates |
( |
LayerContext |
source_context | ) |
|
|
inline |
Copy states from another layer context.
- Parameters
-
[in] | source_context | The source layer context, whose state will be copied to current layer context. |
- Returns
- true means success, while false means failure.
PDFDoc foxit.pdf.LayerContext.GetDocument |
( |
| ) |
|
|
inline |
Get the related PDF document.
- Returns
- The related PDF document object.
bool foxit.pdf.LayerContext.IsEmpty |
( |
| ) |
|
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
- Returns
- true means current object is empty, while false means not.
bool foxit.pdf.LayerContext.IsVisible |
( |
LayerNode |
layer | ) |
|
|
inline |
Check if a specified layer node is visible in current layer context.
- Parameters
-
[in] | layer | A layer node. It should belong to the same PDF document which is related to current layer context. |
- Returns
- true means the layer node is visible, while false means the layer node is invisible.
bool foxit.pdf.LayerContext.MergeStates |
( |
LayerContext |
source_context | ) |
|
|
inline |
Merge states from another layer context.
- Parameters
-
[in] | source_context | The source layer context, whose state will be merged to current layer context. |
- Returns
- true means success, while false means failure.
bool foxit.pdf.LayerContext.Reset |
( |
| ) |
|
|
inline |
Reset current layer context, back to the initialized state.
- Returns
- true means success, while false means failure.
bool foxit.pdf.LayerContext.SetVisible |
( |
LayerNode |
layer, |
|
|
bool |
is_visible |
|
) |
| |
|
inline |
Set the visibility of a specified layer node in current layer context.
- Parameters
-
[in] | layer | A layer node. It should belong to the same PDF document which is related to current layer context. |
[in] | is_visible | true means visible, and false means invisible. |
- Returns
- true means the layer node is visible, while false means the layer node is invisible.