Foxit PDF SDK
FSDK::LayerContext类 参考

Public 成员函数

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

静态 Public 属性

static e_UsageDesign
 用于表示文档设计器的艺术作品结构组织。
 
static e_UsageExport
 用于导出。
 
static e_UsagePrint
 用于打印。
 
static e_UsageView
 PDF 图层使用类型的枚举。 更多...
 
static e_UsageZoom
 用于缩放。
 

详细描述

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

参见
FSDK.Renderer

成员函数说明

◆ constructor()

FSDK::LayerContext::constructor ( document  ,
usage_type   
)

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

参数
[in]document一个有效的 PDF 文档对象。
[in]usage_type图层使用类型。请参考从 FSDK.LayerContext.e_UsageView 开始的值, 这应该是这些值之一,但不包括 FSDK.LayerContext.e_UsageZoom

◆ CopyStates()

FSDK::LayerContext::CopyStates ( source_context  )

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

参数
[in]source_context源图层上下文,其状态将被复制到当前图层上下文。
返回
true 表示成功,而 false 表示失败。

◆ GetDocument()

FSDK::LayerContext::GetDocument ( )

获取相关的 PDF 文档。

返回
相关的 PDF 文档对象。

◆ GetUsageType()

FSDK::LayerContext::GetUsageType ( )

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

返回
图层使用类型。请参考从 FSDK.LayerContext.e_UsageView 开始的值, 这将是这些值之一,但不包括 FSDK.LayerContext.e_UsageZoom

◆ IsEmpty()

FSDK::LayerContext::IsEmpty ( )

检查当前对象是否为空。

当当前对象为空时,意味着当前对象无用。

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

◆ IsVisible()

FSDK::LayerContext::IsVisible ( layer  )

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

参数
[in]layer图层节点。它应属于与当前图层上下文相关的 同一 PDF 文档。
返回
true 表示图层节点可见,而 false 表示图层节点不可见。

◆ MergeStates()

FSDK::LayerContext::MergeStates ( source_context  )

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

参数
[in]source_context源图层上下文,其状态将被合并到当前图层上下文。
返回
true 表示成功,而 false 表示失败。

◆ Reset()

FSDK::LayerContext::Reset ( )

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

返回
true 表示成功,而 false 表示失败。

◆ SetVisible()

FSDK::LayerContext::SetVisible ( layer  ,
is_visible   
)

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

参数
[in]layer图层节点。它应属于与当前图层上下文相关的 同一 PDF 文档。
[in]is_visibletrue 表示可见,而 false 表示不可见。
返回
true 表示图层节点可见,而 false 表示图层节点不可见。

类成员变量说明

◆ e_UsageView

FSDK::LayerContext::e_UsageView
static

PDF 图层使用类型的枚举。

此枚举的值应单独使用。

用于查看器。