Foxit PDF SDK
Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::OFDRenderer类 参考

Public 成员函数

 constructor ()
 构造函数。
 
 constructor (bitmap)
 使用位图对象构造的构造函数。 更多...
 
 IsEmpty ()
 检查当前对象是否为空。 更多...
 
 Release ()
 释放当前 OFD 渲染器对象。 更多...
 
 SetColorMode (color_mode)
 设置颜色模式。 更多...
 
 SetContentFlag (content_flag)
 设置内容标志。 更多...
 
 StartRender (page, matrix)
 开始渲染 OFD 页面。 更多...
 

静态 Public 属性

static e_ColorModeMapping
 将颜色值映射到由背景色和前景色定义的颜色范围。
 
static e_ColorModeMappingGray
 将灰色/白色/黑色值映射到背景/前景；对于其他颜色，不做更改。
 
static e_ColorModeNormal
 用于渲染颜色模式的枚举。 更多...
 
static e_ContentFlagAllContent
 用于 OFD 渲染内容标志的枚举。 更多...
 
static e_ContentFlagAnnot
 如果设置，将渲染注释。（不包括高亮注释和图章）
 
static e_ContentFlagHighLightAnnots
 如果设置，将渲染高亮注释。
 
static e_ContentFlagPage
 如果设置，将渲染页面内容。
 
static e_ContentFlagStampAnnots
 如果设置，将渲染图章注释。
 

详细描述

此类用于将 OFD 页面渲染到位图。 在使用此类之前，请确保 FSDK.Library.InitializeOFDEngine 已成功调用。

参见
FSDK.Library

成员函数说明

◆ constructor()

FSDK::OFDRenderer::constructor ( bitmap  )

使用位图对象构造的构造函数。

参数
[in]bitmap位图对象。不应为空位图。

◆ IsEmpty()

FSDK::OFDRenderer::IsEmpty ( )

检查当前对象是否为空。

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

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

◆ Release()

FSDK::OFDRenderer::Release ( )

释放当前 OFD 渲染器对象。

请在调用 FSDK.Library.ReleaseOFDEngine 之前调用此函数以释放当前 OFD 渲染器对象。

返回
无。

◆ SetColorMode()

FSDK::OFDRenderer::SetColorMode ( color_mode  )

设置颜色模式。

参数
[in]color_mode颜色模式。请参考从 FSDK.OFDRenderer.e_ColorModeNormal 开始的值， 这应该是这些值之一。 默认值为 FSDK.OFDRenderer.e_ColorModeNormal。
返回
无。

◆ SetContentFlag()

FSDK::OFDRenderer::SetContentFlag ( content_flag  )

设置内容标志。

参数
[in]content_flag内容标志。请参考从 FSDK.OFDRenderer.e_ContentFlagAllContent 开始的值， 这可以是这些值之一或其组合。 默认值为 FSDK.OFDRenderer.e_ContentFlagAllContent。
返回
无。

◆ StartRender()

FSDK::OFDRenderer::StartRender ( page  ,
matrix   
)

开始渲染 OFD 页面。

此函数用于开始渲染 OFD 页面。

参数
[in]pageOFD 页面对象。不应为空对象。
[in]matrix用于渲染页面的矩阵，通常由函数 FSDK.OFDPage.GetDisplayMatrix 返回。
返回
渐进式对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度的速率。 如果速率尚未达到 100，调用函数 FSDK.Progressive.Continue 继续进度，直到进度完成。

类成员变量说明

◆ e_ColorModeNormal

FSDK::OFDRenderer::e_ColorModeNormal
static

用于渲染颜色模式的枚举。

此枚举的值应单独使用。正常颜色模式。

◆ e_ContentFlagAllContent

FSDK::OFDRenderer::e_ContentFlagAllContent
static

用于 OFD 渲染内容标志的枚举。

此枚举的值可以单独使用或组合使用。如果设置，将渲染所有内容。此值应单独使用。