Foxit PDF SDK

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

## 构造函数
(BOOL) | - apply
| 应用当前编辑注释：永久移除注释矩形下的文本、图形和注释。 更多...
(void) | - enableAutoFontSize
| 为覆盖文本启用自动字体大小。 更多...
(void) | - enableRepeatOverlayText:
| 设置标志以决定是否重复覆盖文本。 更多...
(FSDefaultAppearance *) | - getDefaultAppearance
| 获取默认外观数据。 更多...
(id) | - init
| 构造函数。
(id) | - initWithAnnot:
| 构造函数，使用父类对象。 更多...
(BOOL) | - isOverlayTextRepeated
| 检查覆盖文本是否重复。 更多...
(BOOL) | - setDefaultAppearance:
| 设置默认外观数据。 更多...
构造函数 继承自 FSMarkup
(FSNote *) | - addReply
| 在回复列表的末尾添加新回复。 更多...
(void) | - addRichText:style:
| 在末尾添加新的富文本字符串。 更多...
(FSNote *) | - addStateAnnot:model:state:
| 添加新的状态注释。 更多...
(FSMarkupArray *) | - getGroupElements
| 从当前标记注释所属的组中获取一个元素（作为标记注释）。 更多...
(FSMarkup *) | - getGroupHeader
| 获取当前标记注释所属组的头注释（作为主注释）。 更多...
(FSNote *) | - getReply:
| 按索引获取回复。 更多...
(int) | - getReplyCount
| 计算所有回复。 更多...
(NSString *) | - getRichTextContent:
| 获取指定索引的富文本字符串的文本字符串。 更多...
(int) | - getRichTextCount
| 获取富文本字符串的数量。 更多...
(FSRichTextStyle *) | - getRichTextStyle:
| 获取指定索引的富文本字符串的样式数据。 更多...
(FSNoteArray *) | - getStateAnnots:
| 获取指定状态模型中的所有状态注释。 更多...
(void) | - insertRichText:content:style:
| 在指定索引位置插入新的富文本字符串。 更多...
(BOOL) | - isGrouped
| 检查当前标记注释是否在组中。 更多...
(BOOL) | - removeAllReplies
| 删除所有回复。 更多...
(BOOL) | - removeAllStateAnnots
| 移除所有状态注释。 更多...
(BOOL) | - removePopup
| 删除相关的弹出注释。 更多...
(BOOL) | - removeReply:
| 按索引删除回复。 更多...
(void) | - removeRichText:
| 移除指定索引的富文本字符串。 更多...
(void) | - setRichTextContent:content:
| 设置指定索引的富文本字符串的文本字符串。 更多...
(void) | - setRichTextStyle:style:
| 设置指定索引的富文本字符串的样式数据。 更多...
(BOOL) | - ungroup
| 将当前标记注释从其所属的组中解组。 更多...
构造函数 继承自 FSAnnot
(BOOL) | - FSMoveWithResetAppearance:is_reset_appearance:
| 将当前注释移动到新位置，由中的新矩形指定。 更多...
(BOOL) | - FSResetApStreamWithIsGenerateNewAppearanceObj:
| 重置外观流。 更多...
(FSPDFStream *) | - getAppearanceStream:appearance_state:
| 获取具有指定类型和状态的注释外观流。 更多...
(FSRectI *) | - getDeviceRect:
| 获取设备坐标系统中的注释矩形。 更多...
(FSPDFDictionary *) | - getDict
| 获取注释的字典对象。 更多...
(FSMatrix2D *) | - getDisplayMatrix:
| 获取显示矩阵，从到 目标设备坐标系统。 更多...
(int) | - getIndex
| 获取当前注释在其所属页面中的索引。 更多...
(FSPDFDictionary *) | - getOptionalContent
| 获取注释可选内容的PDF字典。 更多...
(FSPDFPage *) | - getPage
| 获取相关的PDF页面。 更多...
(FSRectF *) | - getRect
| 获取矩形，以表示。 更多...
(FSAnnotType) | - getType
| 获取当前注释的实际注释类型。 更多...
(BOOL) | - hasProperty:
| 当前注释是否具有指定的注释属性。 更多...
(id) | - initWithPage:annot_dict:
| 构造函数，使用PDF页面和注释的PDF字典。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...
(BOOL) | - isMarkup
| 检查当前注释是否为标记注释。 更多...
(BOOL) | - move:
| 将当前注释移动到新位置，由中的新矩形指定。 更多...
(BOOL) | - removeProperty:
| 删除指定的注释属性。 更多...
(BOOL) | - resetAppearanceStream
| 重置外观流。 更多...

## 属性
unsigned int | applyFillColor
| 获取用于翻转外观的填充颜色，将在应用编辑后使用。
unsigned int | fillColor
| 获取填充颜色。
NSString * | overlayText
| 获取覆盖文本。
FSAlignment | overlayTextAlignment
| 获取覆盖文本的对齐值。 更多...
FSQuadPointsArray * | quadPoints
| 获取四边形。 更多...
属性 继承自 FSMarkup
float | borderOpacity
| 获取注释的边框透明度。
FSDateTime * | creationDateTime
| 获取创建日期时间。
float | fillOpacity
| 获取注释的填充透明度。
NSString * | intent
| 获取意图名称。 更多...
float | opacity
| 获取不透明度值。 更多...
FSPopup * | popup
| 获取相关的弹出注释。 更多...
NSString * | subject
| 获取主题字符串。
NSString * | title
| 获取标题字符串。 更多...
属性 继承自 FSAnnot
unsigned int | borderColor
| 获取边框颜色。 更多...
FSBorderInfo * | borderInfo
| 获取边框信息。 更多...
NSString * | content
| 获取内容。
unsigned int | flags
| 获取注释标志。
FSDateTime * | modifiedDateTime
| 获取最后修改日期时间。
NSString * | uniqueID
| 获取唯一ID。

## 详细描述

类FSRedact 表示福昕自定义注释类型（不是标准注释类型）。这种注释 用于标记PDF页面的一些内容，当编辑注释被应用时，这些内容将被移除。现有的编辑注释可以通过函数 FSPDFPage::getAnnot:和FSPDFPage::getAnnotAtPoint:tolerance:从PDF页面获取。 新的编辑注释由函数FSRedaction::markRedactAnnot:rects:返回，而不是FSPDFPage::addAnnot:rect:。
类FSRedact派生自类FSMarkup ，还提供获取/设置 编辑注释的标记注释基本属性的函数。 目前，FSAnnot::borderInfo可以用于编辑注释，但不会 对编辑注释的外观产生任何影响。 此外，编辑注释不能通过函数FSAnnot::move:移动。

参见
  FSRedaction
  FSPDFPage
  FSMarkup

## 函数文档

## ◆ apply()

- (BOOL) apply |  |  |

应用当前编辑注释：永久移除注释矩形下的文本、图形和注释。

一旦此函数成功调用，当前编辑注释矩形区域内的所有页面内容（文本对象、图像对象和路径对象） 和注释都将被永久移除。但是，如果其他编辑注释与当前编辑相交或包含在当前编辑内， 它们将不会被删除。对于当前编辑注释，它也将被移除（如果有弹出注释的话也一并移除）

- 这意味着当此函数成功时当前注释对象将变得无用。当前编辑注释矩形的区域将被 函数FSRedact::applyFillColor指定的颜色填充。

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

## ◆ enableAutoFontSize()

- (void) enableAutoFontSize |  |  |

为覆盖文本启用自动字体大小。

返回
  无。

## ◆ enableRepeatOverlayText:()

- (void) enableRepeatOverlayText: |  | (BOOL) | is_to_repeat_overlay_text |

设置标志以决定是否重复覆盖文本。

参数

  [in] | is_to_repeat_overlay_text | YES表示重复覆盖文本，而NO表示不重复。 默认值：NO。

返回
  无。

## ◆ getDefaultAppearance()

- (FSDefaultAppearance *) getDefaultAppearance |  |  |

获取默认外观数据。

此属性对编辑注释的外观有影响。默认外观数据可用于 格式化文本。

返回
  默认外观数据。

## ◆ initWithAnnot:()

- (id) initWithAnnot: |  | (FSAnnot*) | annot |

构造函数，使用父类对象。

参数

  [in] | annot | 父类对象。

重载 FSMarkup .

## ◆ isOverlayTextRepeated()

- (BOOL) isOverlayTextRepeated |  |  |

检查覆盖文本是否重复。

返回
  YES表示覆盖文本重复，而NO表示不重复。

## ◆ setDefaultAppearance:()

- (BOOL) setDefaultAppearance: |  | (FSDefaultAppearance*) | default_ap |

设置默认外观数据。

此属性对编辑注释的外观有影响。默认外观数据可用于 格式化文本。
如果用户希望新的默认外观数据对注释的外观产生影响， 请在设置新的默认外观数据后调用函数FSAnnot::resetAppearanceStream。

参数

  [in] | default_ap | 要设置的新默认外观数据。 输入数据的flags可用于决定哪些信息将 使用新数据更新；对于那些未更新的数据，它们将继续使用旧数据。

返回
  YES表示成功，而NO表示失败。 特别地，如果参数default_ap包含任何不正确的值，此函数将返回NO， 例如：
  - 输入数据的flags包含FSDefaultAppearanceFlagFont 但输入数据的font无效。
  - 输入数据的flags包含FSDefaultAppearanceFlagFontSize 但输入数据的text size不大于零。

## 属性说明

## ◆ overlayTextAlignment

- (FSAlignment) overlayTextAlignment
| read write nonatomic assign

获取覆盖文本的对齐值。

此属性对编辑注释外观的覆盖文本有影响。

## ◆ quadPoints

- (FSQuadPointsArray *) quadPoints
| read write nonatomic weak

获取四边形。

四边形中点的顺序应该是：

- 第一个点是四边形左上角的点。
- 第二个点是四边形右上角的点。
- 第三个点是四边形左下角的点。
- 第四个点是四边形右下角的点。