Foxit PDF SDK
FSDK::Redaction类 参考

Public 成员函数

 Apply ()
 在标记区域应用编辑:永久删除标记区域下的文本或图形。 更多...
 
 constructor (document)
 从 PDF 文档对象构造的构造函数。 更多...
 
 EnableFileStream (temp_directory_path, apply_redaction_callback)
 在应用期间为图像对象启用文件流。 更多...
 
 IsEmpty ()
 检查当前对象是否为空。 更多...
 
 MarkRedactAnnot (page, rects)
 标记要编辑的页面内容(文本对象、图像对象和路径对象)。 更多...
 
 StartApply (pause)
 开始在标记区域应用编辑:永久删除标记区域下的文本或图形。 更多...
 

详细描述

编辑 PDF 文件允许用户隐藏敏感信息,同时保持文档的格式。 此类可用于使用编辑注释标记页面内容,并应用编辑以 永久删除(编辑)PDF 文档中的可见文本和图像,以保护机密信息, 例如社会安全号码。

参见
FSDK.Redact

成员函数说明

◆ Apply()

FSDK::Redaction::Apply ( )

在标记区域应用编辑:永久删除标记区域下的文本或图形。

一旦调用此函数,文档中所有标记的页面内容(文本对象、图像对象和路径对象) 将被永久删除。指定标记区域的所有编辑注释将被 删除(连同其弹出注释),并且这些标记区域将被 FSDK.Redact.SetApplyFillColor 指定的颜色填充。

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

◆ constructor()

FSDK::Redaction::constructor ( document  )

从 PDF 文档对象构造的构造函数。

参数
[in]document有效的 PDF 文档对象。
注解
如果在函数 中使用的许可证信息中未定义模块 "Redaction", 这意味着用户无权使用编辑相关函数, 此构造函数将抛出异常 FSDK.e_ErrNoRedactionModuleRight

◆ EnableFileStream()

FSDK::Redaction::EnableFileStream ( temp_directory_path  ,
apply_redaction_callback   
)

在应用期间为图像对象启用文件流。

一旦调用此函数,图像对象流将写入 temp_directory_path 中指定的目录中的临时文件。 临时文件必须在销毁文档之前保留,并将在销毁文档期间自动删除。

参数
temp_directory_path临时目录路径。如果为空,临时目录将默认为当前路径。
apply_redaction_callback应用编辑的回调, 基于回调类 FSDK.ApplyRedactionCallback 实现。
返回
无。

◆ IsEmpty()

FSDK::Redaction::IsEmpty ( )

检查当前对象是否为空。

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

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

◆ MarkRedactAnnot()

FSDK::Redaction::MarkRedactAnnot ( page  ,
rects   
)

标记要编辑的页面内容(文本对象、图像对象和路径对象)。

此函数用于向指定的矩形区域添加特殊标记(称为编辑注释), 以便编辑这些区域中的页面内容。通常,标记的区域有两种外观:

一旦调用函数 FSDK.Redaction.Apply,这些标记区域下的所有页面内容将被 永久删除,并且这些标记区域将始终保持其翻转外观。

参数
[in]page将标记其内容的 PDF 页面。
[in]rects指定页面中要标记的区域。它不应为空数组。 所有输入的矩形将被视为一个编辑注释。
返回
一个编辑注释对象(默认情况下还包含一个弹出注释),具有默认外观:
应用填充颜色 = 黑色,边框颜色 = 红色,不透明度 = 1.0。

◆ StartApply()

FSDK::Redaction::StartApply ( pause  )

开始在标记区域应用编辑:永久删除标记区域下的文本或图形。

此函数类似于函数 FSDK.Redaction.Apply,但此函数将 返回一个渐进式对象,可用于逐步执行编辑。

参数
[in]pause决定应用过程是否应暂停的回调对象。 这可以是 NULL,表示在应用过程中不暂停。 如果这不是 NULL,它应该是由用户实现的有效暂停对象。 默认值:NULL
返回
渐进式对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度的速率。 如果速率尚未达到 100,请调用函数 FSDK.Progressive.Continue 继续进度,直到进度完成。