Foxit PDF SDK

构造函数 | 所有成员列表
FSRedaction类 参考
类 FSRedaction 继承关系图:

## 构造函数
(BOOL) | - apply
| 在标记区域应用保护密文：永久删除标记区域下的文本或图形。 更多...
(void) | - enableFileStream:apply_redaction_callback:
| 在应用过程中为图像对象启用文件流。 更多...
(id) | - initWithDocument:
| 构造函数，从 PDF 文档对象构造。 更多...
(id) | - initWithOther:
| 构造函数，使用另一个保护密文对象。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...
(FSRedact *) | - markRedactAnnot:rects:
| 标记要进行保护密文处理的页面内容（文本对象、图像对象和路径对象）。 更多...
(FSProgressive *) | - startApply:
| 开始在标记区域应用保护密文：永久删除标记区域下的文本或图形。 更多...

## 详细描述

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

参见
  FSRedact

## 函数文档

## ◆ apply()

- (BOOL) apply |  |  |

在标记区域应用保护密文：永久删除标记区域下的文本或图形。

一旦调用此函数，文档中所有标记的页面内容（文本对象、图像对象和路径对象） 将被永久删除。指定标记区域的所有保护密文注释将被 删除（连同它们的弹出注释），这些标记区域将被 FSRedact::applyFillColor 指定的颜色填充。

返回
  YES 表示成功，NO 表示失败。

## ◆ enableFileStream:apply_redaction_callback:()

- (void) enableFileStream: |  | (NSString *) | temp_directory_path
apply_redaction_callback: |  | (id<FSApplyRedactionCallback>) | apply_redaction_callback

在应用过程中为图像对象启用文件流。

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

参数

  临时目录路径。如果为空，临时目录将默认为当前路径。 |
  这个回调通过实现 | class FSApplyRedactionCallback 来应用密文。

返回
  无。

## ◆ initWithDocument:()

- (id) initWithDocument: |  | (FSPDFDoc*) | document |

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

参数

  [in] | document | 有效的 PDF 文档对象。

注解
  如果在函数 FSLibrary::initialize:key: 中使用的许可证信息中未定义"Redaction"模块， 这意味着用户无权使用保护密文相关功能， 此构造函数将抛出异常 FSErrNoRedactionModuleRight。

## ◆ initWithOther:()

- (id) initWithOther: |  | (FSRedaction*) | other |

构造函数，使用另一个保护密文对象。

参数

  [in] | other | 另一个保护密文对象。

## ◆ isEmpty()

- (BOOL) isEmpty |  |  |

检查当前对象是否为空。

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

返回
  YES 表示当前对象为空，NO 表示不为空。

## ◆ markRedactAnnot:rects:()

- (FSRedact *) markRedactAnnot: |  | (FSPDFPage*) | page
rects: |  | (FSRectFArray*) | rects

标记要进行保护密文处理的页面内容（文本对象、图像对象和路径对象）。

此函数用于在指定的矩形区域添加特殊标记（称为保护密文注释）， 以便对这些区域中的页面内容进行保护密文处理。通常，标记区域有两种外观：

- 正常外观，当标记区域未与用户交互时使用。 边框颜色（也称为描边颜色）可以通过 FSAnnot::borderColor 设置。 填充颜色可以通过 FSRedact::fillColor 设置。 不透明度可以通过 FSMarkup::opacity 设置。
- 滚动外观，当用户将光标移入标记区域而不按下鼠标按钮时使用。 边框颜色和填充颜色相同，可以通过 FSRedact::applyFillColor 设置。

一旦调用函数 FSRedaction::apply，这些标记区域下的所有页面内容将被 永久删除，这些标记区域将始终保持其滚动外观。

参数

  [in] | page | 要标记其内容的 PDF 页面。
  [in] | rects | 指定页面中要标记的区域。它不应该是空数组。 所有输入的矩形将被视为一个保护密文注释。

返回
  保护密文注释对象（默认情况下还有一个弹出注释），具有默认外观：
  应用填充颜色 = 黑色，边框颜色 = 红色，不透明度 = 1.0。

## ◆ startApply:()

- (FSProgressive *) startApply: |  | (id<FSPauseCallback>) | pause |

开始在标记区域应用保护密文：永久删除标记区域下的文本或图形。

此函数类似于函数 FSRedaction::apply，但此函数将 返回一个渐进对象，可用于逐步执行保护密文处理。

参数

  [in] | pause | 决定应用过程是否应暂停的回调对象。 这可以是 nil，表示在应用过程中不暂停。 如果不是 nil，它应该是用户实现的有效暂停对象。 默认值：nil。

返回
  渐进对象。请通过函数 FSProgressive::getRateOfProgress 检查当前进度的速率。如果速率尚未达到 100，请调用函数 FSProgressive::resume 继续进度，直到进度完成。