Foxit PDF SDK

Public 类型 | Public 成员函数 | 所有成员列表
foxit.pdf.LayerContext类 参考
类 foxit.pdf.LayerContext 继承关系图:

## Public 类型
enum | UsageType { UsageType.e_UsageView = 0x0000, UsageType.e_UsageDesign = 0x0001, UsageType.e_UsagePrint = 0x0002, UsageType.e_UsageExport = 0x0003, UsageType.e_UsageZoom = 0x0004 }
| PDF图层用途类型的枚举。 更多...

## Public 成员函数
| LayerContext (PDFDoc document, LayerContext.UsageType usage_type)
| 基于PDF文档和指定图层用途类型的构造函数。 更多...
| LayerContext (LayerContext other)
| 拷贝构造函数。 更多...
bool | CopyStates (LayerContext source_context)
| 从另一个图层上下文复制状态。 更多...
PDFDoc | GetDocument ()
| 获取相关的PDF文档。 更多...
LayerContext.UsageType | GetUsageType ()
| 获取用于渲染的图层用途类型。 更多...
bool | IsEmpty ()
| 检查当前对象是否为空。 更多...
bool | IsVisible (LayerNode layer)
| 检查指定图层节点在当前图层上下文中是否可见。 更多...
bool | MergeStates (LayerContext source_context)
| 从另一个图层上下文合并状态。 更多...
bool | Reset ()
| 重置当前图层上下文，返回到初始化状态。 更多...
bool | SetVisible (LayerNode layer, bool is_visible)
| 在当前图层上下文中设置指定图层节点的可见性。 更多...

## 详细描述

此类表示用于渲染的图层上下文。如果用户想要渲染图层，请首先构造一个 图层上下文对象，然后通过函数 common.Renderer.SetLayerContext 将其设置到 foxit.common.Renderer 对象。

参见
  foxit.common.Renderer

## 成员枚举类型说明

## ◆ UsageType

enum foxit.pdf.LayerContext.UsageType
| strong

PDF图层用途类型的枚举。

此枚举的值应单独使用。

枚举值
e_UsageView | 用于查看器。
e_UsageDesign | 用于表示文档设计器的图稿结构组织。
e_UsagePrint | 用于打印。
e_UsageExport | 用于导出。
e_UsageZoom | 用于缩放。

## 构造及析构函数说明

## ◆ LayerContext() [1/2]

foxit.pdf.LayerContext.LayerContext | ( | PDFDoc | document,
|  | LayerContext.UsageType | usage_type
| ) |  |
| inline

基于PDF文档和指定图层用途类型的构造函数。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | usage_type | 图层用途类型。请参考从 foxit.pdf.LayerContext.UsageType.e_UsageView 开始的值， 应该是这些值中的一个，除了 foxit.pdf.LayerContext.UsageType.e_UsageZoom 。

## ◆ LayerContext() [2/2]

foxit.pdf.LayerContext.LayerContext | ( | LayerContext | other | ) |
| inline

拷贝构造函数。

参数

  [in] | other | 另一个图层上下文对象。

## 成员函数说明

## ◆ CopyStates()

bool foxit.pdf.LayerContext.CopyStates | ( | LayerContext | source_context | ) |
| inline

从另一个图层上下文复制状态。

参数

  [in] | source_context | 源图层上下文，其状态将被复制到当前图层上下文。

返回
  true 表示成功，false 表示失败。

## ◆ GetDocument()

PDFDoc foxit.pdf.LayerContext.GetDocument | ( |  | ) |
| inline

获取相关的PDF文档。

返回
  相关的PDF文档对象。

## ◆ GetUsageType()

LayerContext.UsageType foxit.pdf.LayerContext.GetUsageType | ( |  | ) |
| inline

获取用于渲染的图层用途类型。

返回
  图层用途类型。请参考从 foxit.pdf.LayerContext.UsageType.e_UsageView 开始的值， 将是这些值中的一个，除了 foxit.pdf.LayerContext.UsageType.e_UsageZoom 。

## ◆ IsEmpty()

bool foxit.pdf.LayerContext.IsEmpty | ( |  | ) |
| inline

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

返回
  true表示当前对象为空，false表示不为空。

## ◆ IsVisible()

bool foxit.pdf.LayerContext.IsVisible | ( | LayerNode | layer | ) |
| inline

检查指定图层节点在当前图层上下文中是否可见。

参数

  [in] | layer | 图层节点。它应该属于与当前图层上下文相关的同一个PDF文档。

返回
  true表示图层节点可见，false表示图层节点不可见。

## ◆ MergeStates()

bool foxit.pdf.LayerContext.MergeStates | ( | LayerContext | source_context | ) |
| inline

从另一个图层上下文合并状态。

参数

  [in] | source_context | 源图层上下文，其状态将被合并到当前图层上下文。

返回
  true 表示成功，false 表示失败。

## ◆ Reset()

bool foxit.pdf.LayerContext.Reset | ( |  | ) |
| inline

重置当前图层上下文，返回到初始化状态。

返回
  true表示成功，false表示失败。

## ◆ SetVisible()

bool foxit.pdf.LayerContext.SetVisible | ( | LayerNode | layer,
|  | bool | is_visible
| ) |  |
| inline

在当前图层上下文中设置指定图层节点的可见性。

参数

  [in] | layer | 图层节点。它应该属于与当前图层上下文相关的同一个PDF文档。
  [in] | is_visible | true表示可见，false表示不可见。

返回
  true表示图层节点可见，false表示图层节点不可见。