Foxit PDF SDK

构造函数 | 属性 | 所有成员列表
FSPDFPage类 参考

继承自 FSGraphicsObjects .

## 构造函数
(FSAnnot *) | - addAnnot:rect:
| 向当前PDF页面添加注释。 更多...
(FSAnnot *) | - addAnnotWithDictionary:
| 向当前PDF页面添加注释（通过有效的注释字典）。 更多...
(BOOL) | - addImage:frame_index:position:width:height:auto_generate_content:
| 添加图像到当前页面。 更多...
(BOOL) | - addImageFromFilePath:position:width:height:auto_generate_content:
| 从文件路径添加图像到当前页面。 更多...
(FSSignature *) | - addSignature:
| 向PDF页面添加普通签名。 更多...
(FSSignature *) | - addSignatureWithExistedVDict:field_name:signature_type:to_check_permission:existed_signature:
| 使用特定签名中已存在的"V"字典添加签名到 PDF 页面。 更多...
(FSSignature *) | - addSignatureWithFieldName:field_name:
| 向PDF页面添加普通签名。 更多...
(FSSignature *) | - addSignatureWithSignatureType:field_name:signature_type:to_check_permission:
| 向PDF页面添加签名。 更多...
(BOOL) | - addText:rect:style:matrix:is_each_text:disable_embed_font:
| 添加文本到当前页面。 更多...
(FSRectF *) | - addTextWithRotation:rect:style:rotation:rotate_point:disable_embed_font:
| 添加文本到当前页面。 更多...
(FSRectF *) | - calcContentBBox:
| 计算PDF页面的内容区域。 更多...
(FSRectF *) | - calculateNewRectForText:rect:style:rotation:rotate_point:disable_embed_font:
| 计算新文本矩形。 更多...
(void) | - clearRenderCache
| 清除渲染缓存。 更多...
(BOOL) | - flatten:options:
| 拼合当前PDF页面：根据指定选项，注释或表单字段可能成为页面内容的一部分。 更多...
(BOOL) | - flattenAnnot:
| 拼合注释：将注释合并到页面内容中，然后将其移除。 更多...
(FSAnnot *) | - getAnnot:
| 通过索引获取注释。 更多...
(FSAnnot *) | - getAnnotAtDevicePoint:tolerance:matrix:
| 获取指定位置的注释，在设备坐标系统中。 更多...
(FSAnnot *) | - getAnnotAtPoint:tolerance:
| 获取指定位置的注释，在中。 更多...
(int) | - getAnnotCount
| 获取注释的数量。 更多...
(FSPDFArray *) | - getAnnots
| 获取"Annots"的 PDF 数组。 更多...
(FSAnnotArray *) | - getAnnotsAtDevicePoint:tolerance:matrix:
| 获取指定位置的所有注释，在设备坐标系统中。 更多...
(FSAnnotArray *) | - getAnnotsAtPoint:tolerance:
| 获取指定位置的所有注释，在中。 更多...
(FSRectF *) | - getBox:
| 获取页面框。 更多...
(FSPDFObject *) | - getContents
| 获取"Contents"的 PDF 对象。 更多...
(FSPDFDictionary *) | - getDict
| 获取页面字典。 更多...
(FSMatrix2D *) | - getDisplayMatrix:top:width:height:rotate:
| 获取PDF页面的显示矩阵，从到 目标设备坐标系统。 更多...
(FSPDFDoc *) | - getDocument
| 获取当前PDF页面所属的PDF文档。 更多...
(FSGraphicsObject *) | - getGraphicsObjectAtDevicePoint:tolerance:matrix:filter:
| 获取设备坐标系统中指定点的最顶层图形对象，使用指定的类型过滤器。 更多...
(FSGraphicsObject *) | - getGraphicsObjectAtPoint:tolerance:filter:
| 获取指定点的最顶层图形对象，使用指定的类型过滤器。 更多...
(FSGraphicsObject *) | - getGraphicsObjectAtRectangle:filter:
| 获取矩形与指定矩形相交的最顶层图形对象，使用指定的类型过滤器。 更多...
(FSGraphicsObjectArray *) | - getGraphicsObjectsAtDevicePoint:tolerance:matrix:filter:
| 获取设备坐标系统中指定点的所有图形对象，使用指定的类型过滤器。 更多...
(FSGraphicsObjectArray *) | - getGraphicsObjectsAtPoint:tolerance:filter:
| 获取指定点的所有图形对象，使用指定的类型过滤器。 更多...
(FSGraphicsObjectArray *) | - getGraphicsObjectsAtRectangle:filter:
| 获取矩形与指定矩形相交的所有图形对象，使用指定的类型过滤器。 更多...
(float) | - getHeight
| 获取页面高度（单位是1/72英寸）。 更多...
(int) | - getIndex
| 获取页面索引。 更多...
(FSPDFObject *) | - getInheritedAttribute:
| 获取指定属性的 PDF 对象，该属性可能从页面树中的祖先节点继承。 更多...
(FSPDFDictionary *) | - getResources
| 获取"Resources"的 PDF 字典。 更多...
(FSRectF *) | - getSuggestedRect:render_matrix:point:
| 基于渲染结果位图为点（位于 ）获取建议的矩形（位于 ）。 更多...
(FSPDFStream *) | - getThumb
| 获取"Thumb"的 PDF 流。 更多...
(float) | - getWidth
| 获取页面宽度（单位是1/72英寸）。 更多...
(BOOL) | - hasTransparency
| 检查当前PDF页面是否具有透明度。 更多...
(BOOL) | - hasWatermark
| 检查当前页面是否有水印（不包括Foxit PDF SDK试用水印）。 更多...
(id) | - initWithDocument:page_dict:
| 构造函数，从表示PDF页面的PDF字典和包含该字典的PDF文档创建。 更多...
(id) | - initWithOther:
| 构造函数，使用父类对象。 更多...
(BOOL) | - isParsed
| 检查当前页面是否已被解析。 更多...
(BOOL) | - isScanned
| 检查当前PDF页面是否为扫描页面。 更多...
(FSBitmap *) | - loadThumbnail
| 加载缩略图位图。 更多...
(void) | - moveAnnotToFirst:
| 将指定注释更改为所有注释中的第一个。 更多...
(void) | - moveAnnotToLast:
| 将指定注释更改为所有注释中的最后一个。 更多...
(void) | - moveAnnotToNext:
| 交换当前注释与其下一个注释的索引。 更多...
(void) | - moveAnnotToPrev:
| 交换当前注释与其前一个注释的索引。 更多...
(BOOL) | - normalize
| 通过撤销任何旋转并移除到页面"CropBox"的偏移来转换当前PDF页面。 更多...
(BOOL) | - removeAllWatermarks
| 移除所有水印。 更多...
(BOOL) | - removeAnnot:
| 移除注释。 更多...
(BOOL) | - setAnnotGroup:header_index:
| 将所有输入的标记注释组合在一起。 更多...
(void) | - setBox:box:
| 设置页面框。 更多...
(void) | - setClipRect:
| 为当前PDF页面上的所有图形对象设置剪切矩形。 更多...
(void) | - setSize:height:
| 设置页面宽度和高度。 更多...
(void) | - setSizeWithType:
| 设置页面大小类型。 更多...
(void) | - setThumbnail:
| 设置页面缩略图。 更多...
(FSTextObjectArray *) | - splitTextsInRectangle:split_step:
| 分割文本对象，这些对象的矩形（在中）与指定的矩形 （在中）相交，并根据split_step进一步分割相交部分。 更多...
(FSProgressive *) | - startParse:pause:is_reparse:
| 开始解析当前页面。 更多...
(BOOL) | - transform:need_transform_clip_path:need_transform_annotations:
| 转换PDF页面，包括页面上的注释和表单字段。 更多...
(void) | - updateAnnotList
| 更新注释列表。 更多...

## 属性
FSRotation | rotation
| 获取页面旋转。
float | userUnitSize
| 获取用户单位。 更多...

## 详细描述

PDF页面在PDF坐标系统中定义，使用页面的左下角作为 原点(0, 0)。
通常，PDF页面对象通过函数FSPDFDoc::getPage:从PDF文档中获取。 对于大多数情况，PDF页面应该首先被解析然后才能使用。函数FSPDFPage::isParsed可以 用于判断PDF页面是否已被解析。对于未解析的页面，请使用函数 FSPDFPage::startParse:pause:is_reparse:来解析它。
此类提供获取/设置PDF页面数据的函数，如页面宽度/高度、页面旋转、 显示矩阵等。此外，此类还提供检索PDF注释的函数：

- 要获取PDF注释，使用函数FSPDFPage::getAnnot:、FSPDFPage::getAnnotAtPoint:tolerance: 或FSPDFPage::getAnnotAtDevicePoint:tolerance:matrix:。
- 要添加新的PDF注释，使用函数FSPDFPage::addAnnot:rect:。
- 要删除PDF注释，使用函数FSPDFPage::removeAnnot:。

类FSPDFPage派生自类FSGraphicsObjects，因此PDFPage类还提供检索PDF图形对象的函数： retrieve PDF graphics objects: 检索PDF图形对象：

- 要获取PDF图形对象，使用函数FSGraphicsObjects::getFirstGraphicsObjectPosition:、 FSGraphicsObjects::getNextGraphicsObjectPosition:filter:、 FSGraphicsObjects::getLastGraphicsObjectPosition:、 FSGraphicsObjects::getPrevGraphicsObjectPosition:filter: 和 FSGraphicsObjects::getGraphicsObjectByIndex: FSGraphicsObjects::getPrevGraphicsObjectPosition:filter:和FSGraphicsObjects::getGraphicsObjectByIndex: (these functions are inherited from parent class), or FSPDFPage::getGraphicsObjectAtPoint:tolerance:filter:. （这些函数继承自父类），或FSPDFPage::getGraphicsObjectAtPoint:tolerance:filter:。
- 要插入PDF图形对象，使用函数FSGraphicsObjects::insertGraphicsObject:graphics_object: （继承自父类）。
- 要删除PDF图形对象，使用函数FSGraphicsObjects::removeGraphicsObjectByPosition: 或FSGraphicsObjects::removeGraphicsObject:（这些函数继承自父类）。

This class object can also be used to construct objects of other classes in order to access specified information 此类对象也可用于构造其他类的对象，以便访问指定信息 in PDF page: 在PDF页面中：

- To access text content in PDF page, please construct a FSTextPage with PDF page object.
- 要访问PDF页面中的文本内容，请使用PDF页面对象构造FSTextPage 。
- To do reflowing, please construct a FSReflowPage with PDF page object.
- 要进行重排，请使用PDF页面对象构造FSReflowPage 。
- To access additional actions, please construct an FSAdditionalAction object with PDF page object.
- 要访问附加动作，请使用PDF页面对象构造FSAdditionalAction对象。
- To manage the tab order of annotations in PDF page, please construct a FSTabOrderMgr with PDF page object.
- 要管理PDF页面中注释的标签顺序，请使用PDF页面对象构造FSTabOrderMgr 。

参见
  FSPDFDoc
  FSGraphicsObjects
  FSTextPage
  FSReflowPage
  FSAdditionalAction
  FSTabOrderMgr

## 函数文档

## ◆ addAnnot:rect:()

- (FSAnnot *) addAnnot: |  | (FSAnnotType) | type
rect: |  | (FSRectF*) | rect

向当前PDF页面添加注释。

目前，此函数可以支持添加大多数注释类型，除了：
Widget、Sound、Movie、PrinterMark、TrapNet、Watermark、3D、PSInk、Redact。
注意：

- 控件注释用于表示表单字段的外观， 包括签名字段：
  对于签名字段，可以调用函数 FSPDFPage::addSignature: 来 添加新的签名对象。
  对于其他类型的表单字段，可以调用函数 FSForm::addControl:field_name:field_type:rect: 来 添加新的表单字段（包含表单控件）。
- PSInk注释应该通过函数 FSPSI::convertToPDFAnnot:annot_rect:rotate: 从PSI对象转换而来。
- 编辑注释应该通过函数 FSRedaction::markRedactAnnot:rects: 添加来标记PDF页面中的区域。
- 对于支持的注释类型，如果用户未设置新创建注释的任何属性 （除了必需属性）并且直接调用函数 FSAnnot::resetAppearanceStream，将使用默认外观。请参考 具体注释类的注释以了解其默认外观的更多详细信息。

参数

  [in] | type | 要添加的注释类型。请参考从 FSAnnotNote开始的值，应该是这些值中的一个， 除了FSAnnotPSInk、FSAnnotSound、 FSAnnotMovie、FSAnnotWidget、 FSAnnotPrinterMark、FSAnnotTrapNet、 FSAnnotWatermark、FSAnnot3D。
  [in] | rect | 新注释的矩形区域。 对于以下类型的注释，它们在添加时需要有效的矩形区域。 因此对于它们，rect应该是有效的： FSAnnotNote、FSAnnotLink、 FSAnnotSquare、FSAnnotCircle、 FSAnnotFreeText、FSAnnotStamp、 FSAnnotCaret、FSAnnotFileAttachment、 FSAnnotScreen。 对于其余支持的注释类型，当设置了它们的其他必需属性时， 它们的矩形区域将被更新。因此对于这些注释， rect可以是空矩形。如果传递给rect的矩形无效， 将使用空矩形代替。

返回
  新创建的注释对象。

## ◆ addAnnotWithDictionary:()

- (FSAnnot *) addAnnotWithDictionary: |  | (FSPDFDictionary*) | annot_dict |

向当前PDF页面添加注释（通过有效的注释字典）。

参数

  [in] | annot_dict | 要作为注释添加到当前PDF页面的有效注释字典。

返回
  新创建的注释对象。

## ◆ addImage:frame_index:position:width:height:auto_generate_content:()

- (BOOL) addImage: |  | (FSImage*) | image
frame_index: |  | (int) | frame_index
position: |  | (FSPointF*) | position
width: |  | (float) | width
height: |  | (float) | height
auto_generate_content: |  | (BOOL) | auto_generate_content

添加图像到当前页面。

如果图像类型是 FSImageJPG，图像应该保持有效 直到相关文档关闭。

参数

  [in] | image | 图像。其中一个帧将被设置到当前页面。 此图像包含至少一个帧，图像类型不应为 FSImageUnknown。
  [in] | frame_index | 帧索引。有效范围：从 0 到 (count-1)。 count 由函数 FSImage::getFrameCount 返回。
  [in] | position | 指定位置，为图像对象的左下角，位于 中。
  [in] | width | 用于将图像设置到页面中的宽度（单位为 1/72 英寸）。 此值应大于 0。
  [in] | height | 用于将图像设置到页面中的高度（单位为 1/72 英寸）。 此值应大于 0。
  [in] | auto_generate_content | YES 表示内部生成内容。 当使用 NO 时，用户应确保在添加图像后调用函数 FSGraphicsObjects::generateContent。 更多详情请参考函数 FSGraphicsObjects::generateContent。 默认值：YES。

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

## ◆ addImageFromFilePath:position:width:height:auto_generate_content:()

- (BOOL) addImageFromFilePath: |  | (NSString *) | file_path
position: |  | (FSPointF*) | position
width: |  | (float) | width
height: |  | (float) | height
auto_generate_content: |  | (BOOL) | auto_generate_content

从文件路径添加图像到当前页面。

如果输入图像（由文件路径指定）有多个帧，只有第一帧会被默认添加到 当前页面。

参数

  [in] | file_path | 现有图像文件的完整路径。不应为空字符串。
  [in] | position | 指定位置，为图像对象的左下角，位于 中。
  [in] | width | 用于将图像设置到页面中的宽度。 此值应大于 0。
  [in] | height | 用于将图像设置到页面中的高度。 此值应大于 0。
  [in] | auto_generate_content | YES 表示内部生成内容。 当使用 NO 时，用户应确保在添加图像后调用函数 FSGraphicsObjects::generateContent。 更多详情请参考函数 FSGraphicsObjects::generateContent。 默认值：YES。

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

## ◆ addSignature:()

- (FSSignature *) addSignature: |  | (FSRectF*) | rect |

向PDF页面添加普通签名。

对于新的普通签名，其过滤器默认为"Adobe.PPKLite"，子过滤器默认为"adbe.pkcs7.detached"。 有关签名过滤器和子过滤器的更多详细信息，请参考类 FSSignature 。
在对新签名进行签名之前，用户还可以调用类 FSSignature 的设置函数 来设置用于签名和签名外观的其他信息。

参数

  [in] | rect | 新签名的矩形位置，在 中。 它应该是 中的有效矩形。

返回
  新添加的签名对象。

## ◆ addSignatureWithExistedVDict:field_name:signature_type:to_check_permission:existed_signature:()

- (FSSignature *) addSignatureWithExistedVDict: |  | (FSRectF*) | rect
field_name: |  | (NSString *) | field_name
signature_type: |  | (FSSignatureSignatureType) | signature_type
to_check_permission: |  | (BOOL) | to_check_permission
existed_signature: |  | (FSSignature*) | existed_signature

使用特定签名中已存在的"V"字典添加签名到 PDF 页面。

对于新的普通签名，其过滤器默认为"Adobe.PPKLite"，子过滤器默认为"adbe.pkcs7.detached"。 对于新的时间戳签名，其过滤器默认为"Adobe.PPKLite"，子过滤器默认为"ETSI.RFC3161"。 有关签名过滤器和子过滤器的更多详情，请参考类 FSSignature 。
在签署新签名之前，用户还可以调用类 FSSignature 的设置函数 来设置用于签署和签名外观的其他信息。 共享 V 字典后，对与 V 字典相关的条目的任何更改都将同时 影响所有共享 V 字典的签名的外观。

参数

  [in] | rect | 新签名的矩形位置，在 中。 如果参数 signature_type 是 FSSignatureSignatureTypeTimeStamp， 此矩形将被忽略；否则，这应该是 中的有效矩形。
  [in] | field_name | 签名字段名称。这可以是空字符串。
  [in] | signature_type | 签名类型。请参考从 FSSignatureSignatureTypeOrdinary 开始的值，这应该是这些值中的一个。
  [in] | to_check_permission | 一个布尔值，决定Foxit PDF SDK是否应在添加签名前检查PDF文档的权限： YES 表示Foxit PDF SDK应检查文档权限以决定是否允许添加签名， NO 表示Foxit PDF SDK不应在添加签名前检查文档权限。 当此参数为 NO 时，用户应确保检查文档权限以确认是否允许添加签名。 默认值：YES。
  [in] | existed_signature | 其"V"字典将在新添加的签名中使用的签名。

返回
  新添加的签名对象。

## ◆ addSignatureWithFieldName:field_name:()

- (FSSignature *) addSignatureWithFieldName: |  | (FSRectF*) | rect
field_name: |  | (NSString *) | field_name

向PDF页面添加普通签名。

对于新的普通签名，其过滤器默认为"Adobe.PPKLite"，子过滤器默认为"adbe.pkcs7.detached"。 有关签名过滤器和子过滤器的更多详细信息，请参考类 FSSignature 。
在对新签名进行签名之前，用户还可以调用类 FSSignature 的设置函数 来设置用于签名和签名外观的其他信息。

参数

  [in] | rect | 新签名的矩形位置，在 中。 它应该是 中的有效矩形。
  [in] | field_name | 签名字段名称。这可以是空字符串。

返回
  新添加的签名对象。

## ◆ addSignatureWithSignatureType:field_name:signature_type:to_check_permission:()

- (FSSignature *) addSignatureWithSignatureType: |  | (FSRectF*) | rect
field_name: |  | (NSString *) | field_name
signature_type: |  | (FSSignatureSignatureType) | signature_type
to_check_permission: |  | (BOOL) | to_check_permission

向PDF页面添加签名。

对于新的普通签名，其过滤器默认为"Adobe.PPKLite"，子过滤器默认为"adbe.pkcs7.detached"。 对于新的时间戳签名，其过滤器默认为"Adobe.PPKLite"，子过滤器默认为"ETSI.RFC3161"。 有关签名过滤器和子过滤器的更多详细信息，请参考类 FSSignature 。
在对新签名进行签名之前，用户还可以调用类 FSSignature 的设置函数 来设置用于签名和签名外观的其他信息。

参数

  [in] | rect | 新签名的矩形位置，在 中。 如果参数 signature_type 是 FSSignatureSignatureTypeTimeStamp， 此矩形将被忽略；否则，这应该是 中的有效矩形。
  [in] | field_name | 签名字段名称。可以是空字符串。
  [in] | signature_type | 签名类型。请参考从 FSSignatureSignatureTypeOrdinary 开始的值， 应该是这些值中的一个。
  [in] | to_check_permission | 一个布尔值，决定 Foxit PDF SDK 是否应在添加签名前检查 PDF 文档的权限： YES 表示 Foxit PDF SDK 应检查文档权限以决定是否允许添加签名， NO 表示 Foxit PDF SDK 不应在添加签名前检查文档权限。 当此参数为 NO 时，用户应确保检查文档权限以检查是否允许添加签名。 默认值：YES。

返回
  新添加的签名对象。

## ◆ addText:rect:style:matrix:is_each_text:disable_embed_font:()

- (BOOL) addText: |  | (NSString *) | text
rect: |  | (FSRectF*) | rect
style: |  | (FSRichTextStyle*) | style
matrix: |  | (FSMatrix2D*) | matrix
is_each_text: |  | (BOOL) | is_each_text
disable_embed_font: |  | (BOOL) | disable_embed_font

添加文本到当前页面。

如果文本太长无法适合矩形，文本会自动换行。

参数

  [in] | text | 新文本字符串的内容。不应为空字符串。
  [in] | rect | 框矩形，位于 中。
  [in] | style | 用于新文本字符串的样式数据。
  [in] | matrix | 用于添加文本块的变换矩阵。
  [in] | is_each_text | 一个布尔值，指示是否为文本块内的每个文本对象单独应用变换矩阵。 YES 表示为每个文本对象使用单独的矩阵， NO 表示为整个文本块使用相同的矩阵。
  [in] | disable_embed_font | 一个布尔值，表示是否禁用嵌入字体。 YES 表示禁用嵌入字体，NO 表示不禁用。

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

注解
  此函数成功时，应调用函数 FSGraphicsObjects::generateContent。 更多详情请参考函数 FSGraphicsObjects::generateContent。

## ◆ addTextWithRotation:rect:style:rotation:rotate_point:disable_embed_font:()

- (FSRectF *) addTextWithRotation: |  | (NSString *) | text
rect: |  | (FSRectF*) | rect
style: |  | (FSRichTextStyle*) | style
rotation: |  | (int) | rotation
rotate_point: |  | (FSRotationPointOptions) | rotate_point
disable_embed_font: |  | (BOOL) | disable_embed_font

添加文本到当前页面。

如果文本太长无法适合矩形，文本会自动换行。

参数

  [in] | text | 新文本字符串的内容。不应为空字符串。
  [in] | rect | 框矩形，位于 中。
  [in] | style | 用于新文本字符串的样式数据。
  [in] | rotation | 新文本字符串的旋转值。
  [in] | rotate_point | 旋转参考点。请参考从 FSRotationPointCenter 开始的值， 应该是这些值中的一个。
  [in] | disable_embed_font | 一个布尔值，表示是否禁用嵌入字体。 YES 表示禁用嵌入字体，NO 表示不禁用。

返回
  文本块内容的矩形。

注解
  此函数成功时，应调用函数 FSGraphicsObjects::generateContent。 更多详情请参考函数 FSGraphicsObjects::generateContent。

## ◆ calcContentBBox:()

- (FSRectF *) calcContentBBox: |  | (FSPDFPageCalcMarginMode) | mode |

计算PDF页面的内容区域。

在使用此函数之前，请确保当前页面已被解析。

参数

  [in] | mode | 计算模式。它应该是以下值之一： FSPDFPageCalcContentsBox表示 根据所有内容的边界框计算边距。 FSPDFPageCalcDetection表示 通过检测路径或图像来计算边距。

返回
  包含可见页面内容的最小矩形。

## ◆ calculateNewRectForText:rect:style:rotation:rotate_point:disable_embed_font:()

- (FSRectF *) calculateNewRectForText: |  | (NSString *) | text
rect: |  | (FSRectF*) | rect
style: |  | (FSRichTextStyle*) | style
rotation: |  | (int) | rotation
rotate_point: |  | (FSRotationPointOptions) | rotate_point
disable_embed_font: |  | (BOOL) | disable_embed_font

计算新文本矩形。

参数

  [in] | text | 新文本字符串的内容。不应为空字符串。
  [in] | rect | 框矩形，位于 中。
  [in] | style | 用于新文本字符串的样式数据。
  [in] | rotation | 新文本字符串的旋转值。
  [in] | rotate_point | 旋转参考点。请参考从 FSRotationPointCenter 开始的值， 应该是这些值中的一个。
  [in] | disable_embed_font | 一个布尔值，表示是否禁用嵌入字体。 YES 表示禁用嵌入字体，NO 表示不禁用。

返回
  文本块内容的矩形。

## ◆ clearRenderCache()

- (void) clearRenderCache |  |  |

清除渲染缓存。

返回
  无。

## ◆ flatten:options:()

- (BOOL) flatten: |  | (BOOL) | for_display
options: |  | (unsigned int) | options

拼合当前PDF页面：根据指定选项，注释或表单字段可能成为页面内容的一部分。

注释标志可以决定注释是否可以显示或是否可以打印。 这也会影响拼合结果：

- 如果拼合结果用于显示，只有可以显示的注释 才会被拼合成为页面内容的一部分。
- 如果拼合结果用于打印，只有可以打印的注释 才会被拼合成为页面内容的一部分。

表单字段的外观由控件注释表示，控件注释是一种注释，在Foxit PDF SDK中 被视为表单控件。因此，当表单字段要被拼合时，注释标志也会影响表单字段。 有关注释标志的更多详细信息，请参考从 FSAnnotFlagInvisible 开始的值 以及<PDF参考1.7>中的第8.4.2节"注释标志"。
注释或表单字段被拼合后，它将不再是注释或表单字段。 成功拼合当前页面后，用户应通过函数 FSPDFPage::startParse:pause:is_reparse: 重新解析此页面。

参数

  [in] | for_display | 决定拼合结果的用途： YES 表示拼合结果仅用于显示， NO 表示拼合结果仅用于打印。
  [in] | options | 拼合选项。请参考从 FSPDFPageFlattenAll 开始的值， 这应该是其中一个或它们的组合。 特别地，如果同时使用 FSPDFPageFlattenNoAnnot 和 FSPDFPageFlattenNoFormControl， 这意味着没有任何内容要拼合到页面，此函数将 直接返回 YES。 默认值：FSPDFPageFlattenAll。

返回
  YES 表示当前页面拼合成功，NO 表示失败。

## ◆ flattenAnnot:()

- (BOOL) flattenAnnot: |  | (FSAnnot*) | annot |

拼合注释：将注释合并到页面内容中，然后将其移除。

成功拼合注释后，用户应通过函数 FSPDFPage::startParse:pause:is_reparse: 重新解析此页面。

参数

  [in] | annot | 要拼合和移除的注释。

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

## ◆ getAnnot:()

- (FSAnnot *) getAnnot: |  | (int) | index |

通过索引获取注释。

参数

  [in] | index | 注释索引。有效范围：从0到(count-1)。 count由函数FSPDFPage::getAnnotCount返回。

返回
  注释对象。

## ◆ getAnnotAtDevicePoint:tolerance:matrix:()

- (FSAnnot *) getAnnotAtDevicePoint: |  | (FSPointF*) | position
tolerance: |  | (float) | tolerance
matrix: |  | (FSMatrix2D*) | matrix

获取指定位置的注释，在设备坐标系统中。

如果在此指定位置有多个注释，此函数将始终返回 最顶层的注释。具有标志FSAnnotFlagNoView或 FSAnnotFlagHidden或FSAnnotFlagInvisible 的注释不会被此函数检索。如果返回的注释有标志 FSAnnotFlagReadOnly，则无法修改。

参数

  [in] | position | 指定位置，在设备坐标系统中。
  [in] | tolerance | 容差值。有效范围：0.0f到30.0f。
  [in] | matrix | 变换矩阵。通常这由函数 FSPDFPage::getDisplayMatrix:top:width:height:rotate:返回。如果这是nil，当前函数将 具有与函数FSPDFPage::getAnnotAtPoint:tolerance:相同的功能。 默认值：nil。

返回
  注释对象。如果返回注释对象的函数FSAnnot::isEmpty 的返回值为YES，表示找不到PDF注释。

## ◆ getAnnotAtPoint:tolerance:()

- (FSAnnot *) getAnnotAtPoint: |  | (FSPointF*) | position
tolerance: |  | (float) | tolerance

获取指定位置的注释，在中。

如果在此指定位置有多个注释，此函数将始终返回 最顶层的注释。具有标志FSAnnotFlagNoView或 FSAnnotFlagHidden或FSAnnotFlagInvisible 的注释不会被此函数检索。如果返回的注释有标志 FSAnnotFlagReadOnly，则无法修改。

参数

  [in] | position | 指定位置，在中。
  [in] | tolerance | 容差值。有效范围：0.0f到30.0f。

返回
  注释对象。如果返回注释对象的函数FSAnnot::isEmpty 的返回值为YES，表示找不到PDF注释。

## ◆ getAnnotCount()

- (int) getAnnotCount |  |  |

获取注释的数量。

返回
  注释的数量。

## ◆ getAnnots()

- (FSPDFArray *) getAnnots |  |  |

获取"Annots"的 PDF 数组。

注解
  更多详情请参考 <PDF Reference 1.7> P147 中的"TABLE 3.27 Entries in a page object"。

返回
  "Annots"的 PDF 数组。 如果没有"Annots"条目或发生任何错误，此函数将返回 nil。

## ◆ getAnnotsAtDevicePoint:tolerance:matrix:()

- (FSAnnotArray *) getAnnotsAtDevicePoint: |  | (FSPointF*) | position
tolerance: |  | (float) | tolerance
matrix: |  | (FSMatrix2D*) | matrix

获取指定位置的所有注释，在设备坐标系统中。

在一个指定位置，可能存在多个注释。 此函数可用于检索指定位置的所有这些注释。 具有标志FSAnnotFlagNoView或 FSAnnotFlagHidden或FSAnnotFlagInvisible 的注释不会被此函数检索。
如果返回注释数组对象的函数FSAnnotArray::getAt:的返回注释对象 有标志FSAnnotFlagReadOnly，表示该注释 无法修改。

参数

  [in] | position | 指定位置，在设备坐标系统中。
  [in] | tolerance | 容差值。有效范围：0.0f到30.0f。
  [in] | matrix | 变换矩阵。通常这由函数 FSPDFPage::getDisplayMatrix:top:width:height:rotate:返回。如果这是nil，当前函数将 具有与函数FSPDFPage::getAnnotAtPoint:tolerance:相同的功能。 默认值：nil。

返回
  注释数组。如果返回注释数组对象的函数FSAnnotArray::getSize 的返回值为0，表示找不到PDF注释。

## ◆ getAnnotsAtPoint:tolerance:()

- (FSAnnotArray *) getAnnotsAtPoint: |  | (FSPointF*) | position
tolerance: |  | (float) | tolerance

获取指定位置的所有注释，在中。

在一个指定位置，可能存在多个注释。 此函数可用于检索指定位置的所有这些注释。 具有标志FSAnnotFlagNoView或 FSAnnotFlagHidden或FSAnnotFlagInvisible 的注释不会被此函数检索。
如果返回注释数组对象的函数FSAnnotArray::getAt:的返回注释对象 有标志FSAnnotFlagReadOnly，表示该注释 无法修改。

参数

  [in] | position | 指定位置，在中。
  [in] | tolerance | 容差值。有效范围：0.0f到30.0f。

返回
  注释数组。如果返回注释数组对象的函数FSAnnotArray::getSize 的返回值为0，表示找不到PDF注释。

## ◆ getBox:()

- (FSRectF *) getBox: |  | (FSPDFPageBoxType) | box_type |

获取页面框。

参数

  [in] | box_type | 页面框类型。请参考从 FSPDFPageMediaBox 开始的值， 这应该是这些值中的一个。

返回
  一个框矩形，在 中。

## ◆ getContents()

- (FSPDFObject *) getContents |  |  |

获取"Contents"的 PDF 对象。

注解
  "Contents"可以是 PDF 流或 PDF 数组。更多详情请参考 <PDF Reference 1.7> P146 中的 "TABLE 3.27 Entries in a page object"。

返回
  "Contents"的 PDF 对象。 如果没有"Contents"条目或发生任何错误，此函数将返回 nil。

## ◆ getDict()

- (FSPDFDictionary *) getDict |  |  |

获取页面字典。

返回
  页面字典对象。如果有任何错误，此函数将返回 nil。

## ◆ getDisplayMatrix:top:width:height:rotate:()

- (FSMatrix2D *) getDisplayMatrix: |  | (int) | left
top: |  | (int) | top
width: |  | (int) | width
height: |  | (int) | height
rotate: |  | (FSRotation) | rotate

获取PDF页面的显示矩阵，从到 目标设备坐标系统。

参数

  [in] | left | 设备坐标系统中变换区域的左侧位置，通常以像素为单位。
  [in] | top | 设备坐标系统中变换区域的顶部位置，通常以像素为单位。
  [in] | width | 设备坐标系统中变换区域的宽度，通常以像素为单位。
  [in] | height | 设备坐标系统中变换区域的高度，通常以像素为单位。
  [in] | rotate | 旋转值。请参考从FSRotation0开始的值， 这应该是这些值中的一个，除了FSRotationUnknown。

返回
  用于当前PDF页面的显示矩阵。

## ◆ getDocument()

- (FSPDFDoc *) getDocument |  |  |

获取当前PDF页面所属的PDF文档。

返回
  一个PDF文档对象。

## ◆ getGraphicsObjectAtDevicePoint:tolerance:matrix:filter:()

- (FSGraphicsObject *) getGraphicsObjectAtDevicePoint: |  | (FSPointF*) | point
tolerance: |  | (float) | tolerance
matrix: |  | (FSMatrix2D*) | matrix
filter: |  | (FSGraphicsObjectType) | filter

获取设备坐标系统中指定点的最顶层图形对象，使用指定的类型过滤器。

参数

  [in] | point | 指定位置，在设备坐标系统中。
  [in] | tolerance | 图形对象命中检测的容差值，以点为单位。它应该是正值。
  [in] | matrix | 转换矩阵。通常这是由函数 FSPDFPage::getDisplayMatrix:top:width:height:rotate: 返回的。 默认值：nil。
  [in] | filter | 指定要获取的图形对象类型的类型过滤器。 请参考从 FSGraphicsObjectTypeAll 开始的值， 这应该是这些值中的一个。 FSGraphicsObjectTypeAll 表示所有类型的图形对象。 默认值：FSGraphicsObjectTypeAll。

返回
  一个 FSGraphicsObject 对象。如果找不到图形对象，此函数将返回 nil。

## ◆ getGraphicsObjectAtPoint:tolerance:filter:()

- (FSGraphicsObject *) getGraphicsObjectAtPoint: |  | (FSPointF*) | point
tolerance: |  | (float) | tolerance
filter: |  | (FSGraphicsObjectType) | filter

获取指定点的最顶层图形对象，使用指定的类型过滤器。

参数

  [in] | point | 指定位置，在 中。
  [in] | tolerance | 图形对象命中检测的容差值，以点为单位。它应该是正值。
  [in] | filter | 指定要获取的图形对象类型的类型过滤器。 请参考从 FSGraphicsObjectTypeAll 开始的值， 这应该是这些值中的一个。 FSGraphicsObjectTypeAll 表示所有类型的图形对象。 默认值：FSGraphicsObjectTypeAll。

返回
  一个 FSGraphicsObject 对象。如果找不到图形对象，此函数将返回 nil。

## ◆ getGraphicsObjectAtRectangle:filter:()

- (FSGraphicsObject *) getGraphicsObjectAtRectangle: |  | (FSRectF*) | rect
filter: |  | (FSGraphicsObjectType) | filter

获取矩形与指定矩形相交的最顶层图形对象，使用指定的类型过滤器。

参数

  [in] | rect | 指定的矩形，位于 中。
  [in] | filter | 类型过滤器，指定要获取哪种图形对象。 请参考从 FSGraphicsObjectTypeAll 开始的值， 应该是这些值中的一个。 FSGraphicsObjectTypeAll 表示所有类型的图形对象。 默认值：FSGraphicsObjectTypeAll。

返回
  矩形与指定矩形相交的图形对象。 如果找不到合适的图形对象，此函数将返回 nil。

## ◆ getGraphicsObjectsAtDevicePoint:tolerance:matrix:filter:()

- (FSGraphicsObjectArray *) getGraphicsObjectsAtDevicePoint: |  | (FSPointF*) | point
tolerance: |  | (float) | tolerance
matrix: |  | (FSMatrix2D*) | matrix
filter: |  | (FSGraphicsObjectType) | filter

获取设备坐标系统中指定点的所有图形对象，使用指定的类型过滤器。

参数

  [in] | point | 指定位置，在设备坐标系统中。
  [in] | tolerance | 图形对象命中检测的容差值，以点为单位。它应该是正值。
  [in] | matrix | 转换矩阵。通常这是由函数 FSPDFPage::getDisplayMatrix:top:width:height:rotate: 返回的矩阵。 默认值：nil。
  [in] | filter | 类型过滤器，指定要获取哪种图形对象。 请参考从 FSGraphicsObjectTypeAll 开始的值， 应该是这些值中的一个。 FSGraphicsObjectTypeAll 表示所有类型的图形对象。 默认值：FSGraphicsObjectTypeAll。

返回
  FSGraphicsObject 对象数组。

## ◆ getGraphicsObjectsAtPoint:tolerance:filter:()

- (FSGraphicsObjectArray *) getGraphicsObjectsAtPoint: |  | (FSPointF*) | point
tolerance: |  | (float) | tolerance
filter: |  | (FSGraphicsObjectType) | filter

获取指定点的所有图形对象，使用指定的类型过滤器。

参数

  [in] | point | 指定位置，在 中。
  [in] | tolerance | 图形对象命中检测的容差值，以点为单位。它应该是正值。
  [in] | filter | 指定要获取的图形对象类型的类型过滤器。 请参考从 FSGraphicsObjectTypeAll 开始的值， 这应该是这些值中的一个。 FSGraphicsObjectTypeAll 表示所有类型的图形对象。 默认值：FSGraphicsObjectTypeAll。

返回
  FSGraphicsObject 对象的数组。

## ◆ getGraphicsObjectsAtRectangle:filter:()

- (FSGraphicsObjectArray *) getGraphicsObjectsAtRectangle: |  | (FSRectF*) | rect
filter: |  | (FSGraphicsObjectType) | filter

获取矩形与指定矩形相交的所有图形对象，使用指定的类型过滤器。

参数

  [in] | rect | 指定的矩形，位于 中。
  [in] | filter | 类型过滤器，指定要获取哪种图形对象。 请参考从 FSGraphicsObjectTypeAll 开始的值， 应该是这些值中的一个。 FSGraphicsObjectTypeAll 表示所有类型的图形对象。 默认值：FSGraphicsObjectTypeAll。

返回
  矩形与指定矩形相交的图形对象数组。

## ◆ getHeight()

- (float) getHeight |  |  |

获取页面高度（单位是1/72英寸）。

返回
  页面高度。

## ◆ getIndex()

- (int) getIndex |  |  |

获取页面索引。

返回
  页面索引，从0开始，在相关PDF文档的页面数范围内。

## ◆ getInheritedAttribute:()

- (FSPDFObject *) getInheritedAttribute: |  | (NSString *) | attruibute_name |

获取指定属性的 PDF 对象，该属性可能从页面树中的祖先节点继承。

某些页面属性被指定为可继承的，如"Resources"、"MediaBox"、"CropBox" 和"Rotate"。更多详情请参考 <PDF Reference 1.7> P145 中的"TABLE 3.27 Entries in a page object" 和 <PDF Reference 1.7> P149 中的"Inheritance of Page Attributes"。

参数

  [in] | attruibute_name | 要查找的属性名称。

返回
  PDF 对象。如果未找到，此函数将返回 nil。

## ◆ getResources()

- (FSPDFDictionary *) getResources |  |  |

获取"Resources"的 PDF 字典。

注解
  更多详情请参考 <PDF Reference 1.7> P145 中的"TABLE 3.27 Entries in a page object"。

返回
  "Resources"的 PDF 字典。 如果没有"Resources"条目或发生任何错误，此函数将返回 nil。

## ◆ getSuggestedRect:render_matrix:point:()

- (FSRectF *) getSuggestedRect: |  | (FSBitmap*) | render_result
render_matrix: |  | (FSMatrix2D*) | render_matrix
point: |  | (FSPointF*) | point

基于渲染结果位图为点（位于 ）获取建议的矩形（位于 ）。

此函数可以帮助用户在指定点周围定位矩形区域（作为建议矩形）。当检索到有效的建议矩形时， 用户可以使用该矩形向 PDF 页面添加内容，例如新的注释、新的表单字段、新的签名等。
点的建议矩形是指包含指定点的矩形，并且可以在指定点周围的空白位置尽可能大地绘制。 但是，如果从该点向左/右/上/下任何方向直接到达输入位图边缘，则无法检索到建议矩形。
此函数不支持 Rbg565 位图。如果输入位图是 Rbg565 位图，此函数将直接返回空矩形。

参数

  [in] | render_result | 作为渲染当前 PDF 页面结果的位图。这应该是有效的位图对象。
  [in] | render_matrix | 用于渲染当前 PDF 页面并生成参数 render_result 作为渲染结果的变换矩阵。
  [in] | point | 要为其查找建议矩形的点（位于 ）。

返回
  中的建议矩形。如果返回的矩形对象的函数 RectF::IsEmpty 返回值为 YES，表示找不到合适的建议矩形。

## ◆ getThumb()

- (FSPDFStream *) getThumb |  |  |

获取"Thumb"的 PDF 流。

注解
  更多详情请参考 <PDF Reference 1.7> P146 中的"TABLE 3.27 Entries in a page object"。

返回
  "Thumb"的 PDF 流。 如果没有"Thumb"条目或发生任何错误，此函数将返回 nil。

## ◆ getWidth()

- (float) getWidth |  |  |

获取页面宽度（单位是1/72英寸）。

返回
  页面宽度。

## ◆ hasTransparency()

- (BOOL) hasTransparency |  |  |

检查当前PDF页面是否具有透明度。

在使用此函数之前，请确保当前页面已被解析。

返回
  YES 表示当前页面具有透明度， NO 表示当前页面不具有透明度。

## ◆ hasWatermark()

- (BOOL) hasWatermark |  |  |

检查当前页面是否有水印（不包括Foxit PDF SDK试用水印）。

在使用此函数之前，请确保当前页面已被解析。

返回
  YES 表示当前页面有水印，NO 表示 当前页面没有水印。

## ◆ initWithDocument:page_dict:()

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

构造函数，从表示PDF页面的PDF字典和包含该字典的PDF文档创建。

参数

  [in] | document | 有效的PDF文档。
  [in] | page_dict | PDF页面的PDF字典。它应该属于参数document指定的PDF文档。

## ◆ initWithOther:()

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

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

参数

  [in] | other | 父类对象。

## ◆ isParsed()

- (BOOL) isParsed |  |  |

检查当前页面是否已被解析。

返回
  YES 表示当前页面已被解析， NO 表示当前页面尚未被解析。

## ◆ isScanned()

- (BOOL) isScanned |  |  |

检查当前PDF页面是否为扫描页面。

在使用此函数之前，请确保当前页面已被解析。

返回
  YES 表示当前页面是扫描页面， NO 表示当前页面不是扫描页面。

## ◆ loadThumbnail()

- (FSBitmap *) loadThumbnail |  |  |

加载缩略图位图。

返回
  当前页面的缩略图位图。如果返回位图对象的函数FSBitmap::isEmpty 的返回值为YES，表示找不到缩略图。

## ◆ moveAnnotToFirst:()

- (void) moveAnnotToFirst: |  | (FSAnnot*) | annot |

将指定注释更改为所有注释中的第一个。

在PDF页面中，所有注释都在注释列表中管理。在注释列表中， 具有较小索引（位于列表前部）的注释将首先绘制到页面上， 具有较大索引（位于列表后部）的注释将稍后绘制到页面上。 因此，在页面中，如果一个注释在z顺序中显示在其他注释之上，这意味着 它的索引比注释列表中的其他注释更大。
此函数用于将注释从当前索引位置移动到注释列表中的第一个位置， 以便在显示时将注释移动到z顺序的底部。

参数

  [in] | annot | 要移动到第一位的注释对象。它应该在当前PDF页面中。

返回
  无。

## ◆ moveAnnotToLast:()

- (void) moveAnnotToLast: |  | (FSAnnot*) | annot |

将指定注释更改为所有注释中的最后一个。

在PDF页面中，所有注释都在注释列表中管理。在注释列表中， 具有较小索引（位于列表前部）的注释将首先绘制到页面上， 具有较大索引（位于列表后部）的注释将稍后绘制到页面上。 因此，在页面中，如果一个注释在z顺序中显示在其他注释之上，这意味着 它的索引比注释列表中的其他注释更大。
此函数用于将注释从当前索引位置移动到注释列表中的最后位置， 以便在显示时将注释移动到z顺序的顶部。

参数

  [in] | annot | 要移动到最后位的注释对象。它应该在当前PDF页面中。

返回
  无。

## ◆ moveAnnotToNext:()

- (void) moveAnnotToNext: |  | (FSAnnot*) | annot |

交换当前注释与其下一个注释的索引。

在PDF页面中，所有注释都在注释列表中管理。在注释列表中， 具有较小索引（位于列表前部）的注释将首先绘制到页面上， 具有较大索引（位于列表后部）的注释将稍后绘制到页面上。 因此，在页面中，如果一个注释在z顺序中显示在其他注释之上，这意味着 它的索引比注释列表中的其他注释更大。
此函数用于交换当前注释与其下一个注释的索引位置 在注释列表中，以便在显示时将注释移动到z顺序中的较高级别。

参数

  [in] | annot | 要移动的注释对象。它应该在当前PDF页面中。

返回
  无。

## ◆ moveAnnotToPrev:()

- (void) moveAnnotToPrev: |  | (FSAnnot*) | annot |

交换当前注释与其前一个注释的索引。

在PDF页面中，所有注释都在注释列表中管理。在注释列表中， 具有较小索引（位于列表前部）的注释将首先绘制到页面上， 具有较大索引（位于列表后部）的注释将稍后绘制到页面上。 因此，在页面中，如果一个注释在z顺序中显示在其他注释之上，这意味着 它的索引比注释列表中的其他注释更大。
此函数用于交换当前注释与其前一个注释的索引位置 在注释列表中，以便在显示时将注释移动到z顺序中的较低级别。

参数

  [in] | annot | 要移动的注释对象。它应该在当前PDF页面中。

返回
  无。

## ◆ normalize()

- (BOOL) normalize |  |  |

通过撤销任何旋转并移除到页面"CropBox"的偏移来转换当前PDF页面。

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

注解
  注释和表单字段也会被调整以保持在PDF页面上的相同相对位置。 这使得向PDF页面添加新项目变得更容易，因为坐标系统将相对于 可见页面的左下角。

## ◆ removeAllWatermarks()

- (BOOL) removeAllWatermarks |  |  |

移除所有水印。

在使用此函数之前，请确保当前页面已被解析。

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

## ◆ removeAnnot:()

- (BOOL) removeAnnot: |  | (FSAnnot*) | annot |

移除注释。

此函数可以移除任何通过获取函数或添加函数返回的注释。
但对于控件注释，此函数只能移除独立的控件注释。 如果控件注释与表单字段关联，此函数无法移除它并且 会抛出异常FSErrUnsupported。
对于与表单字段关联的控件注释，请调用函数 FSForm::removeControl:来移除它及其关联的表单控件。

参数

  [in] | annot | 要移除的注释对象。它应该在当前PDF页面中。

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

## ◆ setAnnotGroup:header_index:()

- (BOOL) setAnnotGroup: |  | (FSMarkupArray*) | annot_array
header_index: |  | (int) | header_index

将所有输入的标记注释组合在一起。

标记注释可以被分组。组由一个主注释和一个或 多个从属注释组成。主注释中的某些条目被视为组属性， 应该适用于整个组；从属注释中相应的条目 应该被忽略。这些条目包括内容、最后修改时间、填充颜色/边框颜色、 标题、弹出注释、创建时间、主题和打开状态。因此用户应该 尊重组属性：当组中注释的属性被更改时， 同一组中的其他注释也应该被更改。
操作组中任何注释的操作，如移动、剪切和复制，应该被 查看器应用程序视为作用于整个组。

参数

  [in] | annot_array | 一个标记对象数组，指定要 组合在一起的标记注释。此数组应至少包含 2个标记注释，并且此数组中的所有标记注释应该 彼此不同。此数组中的所有标记注释应该 在当前页面中。 特别地，如果此数组中的标记注释已经在另一个组中， 该组将被设置为具有新标题的新组。
  [in] | header_index | 指定参数 annot_array 中标记注释的索引， 作为组的标题。有效范围：从 0 到 (annot_count -1)。

返回
  YES 表示成功将输入的标记注释组合在一起，NO 表示失败。

## ◆ setBox:box:()

- (void) setBox: |  | (FSPDFPageBoxType) | box_type
box: |  | (FSRectF*) | box

设置页面框。

参数

  [in] | box_type | 页面框类型。请参考从 FSPDFPageMediaBox 开始的值， 这应该是这些值中的一个。
  [in] | box | 新的框矩形，在 中。

返回
  无。

## ◆ setClipRect:()

- (void) setClipRect: |  | (FSRectF*) | clip_rect |

为当前PDF页面上的所有图形对象设置剪切矩形。

此函数成功完成后，请通过函数 FSPDFPage::startParse:pause:is_reparse: 重新解析当前页面，参数 is_reparse 为 YES。

参数

  [in] | clip_rect | 新的剪切矩形，在 中。

返回
  无。

## ◆ setSize:height:()

- (void) setSize: |  | (float) | width
height: |  | (float) | height

设置页面宽度和高度。

当改变页面宽度/高度时，Foxit PDF SDK总是按以下方式操作：
首先，选择"页面旋转为0"作为基准页面状态，选择 页面的左下角（页面旋转为0时）作为基准点。 然后，总是改变顶部页面边界和右侧页面边界的位置 （页面旋转为0时）来改变页面大小。

参数

  [in] | width | 新的页面宽度。它应该是正值，单位是1/72英寸。
  [in] | height | 新的页面高度。它应该是正值，单位是1/72英寸。

返回
  无。

## ◆ setSizeWithType:()

- (void) setSizeWithType: |  | (FSPDFPageSize) | size |

设置页面大小类型。

当改变页面大小时，Foxit PDF SDK总是按以下方式操作：
首先，选择"页面旋转为0"作为基准页面状态，选择 页面的左下角（页面旋转为0时）作为基准点。 然后，总是改变顶部页面边界和右侧页面边界的位置 （页面旋转为0时）来改变页面大小。

参数

  [in] | size | 指定当前页面新大小的大小类型。请参考从 FSPDFPageSizeLetter 开始的值，这应该是这些值中的一个。

返回
  无。

## ◆ setThumbnail:()

- (void) setThumbnail: |  | (FSBitmap*) | thumbnail |

设置页面缩略图。

缩略图位图不使用alpha通道。因此建议用户设置 没有alpha通道的位图作为新缩略图。如果设置了带有alpha通道的位图， 新缩略图默认将使用白色背景。 目前，此函数不支持格式为 FSBitmapDIBRgb565 的位图。

参数

  [in] | thumbnail | 新的页面缩略图。它应该是有效的位图。

返回
  无。

## ◆ splitTextsInRectangle:split_step:()

- (FSTextObjectArray *) splitTextsInRectangle: |  | (FSRectF*) | rect
split_step: |  | (int) | split_step

分割文本对象，这些对象的矩形（在中）与指定的矩形 （在中）相交，并根据split_step进一步分割相交部分。

此函数根据split_step分割与指定矩形相交的文本对象。 当文本对象与指定矩形相交时，相交部分将根据split_step被分为一个或多个 文本对象。同样，对于只部分与指定矩形相交的文本对象， 它们的非相交部分将被分离出来并作为单独的文本对象处理。如果split_step大于0， 与指定矩形相交的文本对象部分将被分割为几个文本对象。具体来说，每个新的 文本对象将对应指定矩形中的一个段，每个段中的单词数由 split_step定义。如果相交部分中剩余的单词数少于split_step，那些剩余的 单词将被组合成一个文本对象。如果 split_step 为 0，则与指定矩形相交的文本对象的 相交部分将不再进一步分割，将被组合成一个文本对象。

参数

  [in] | rect | 指定的矩形，位于 中。
  [in] | split_step | 用于分割与指定矩形相交的文本对象的单词数。 此值不能为负数。值为 0 表示与指定矩形相交的文本对象将不再 进一步分割，将被组合成一个文本对象。

返回
  分割后与指定矩形相交的文本图形对象数组。

注解
  矩形（在 中）与指定矩形（在 中）相交的文本对象将分别分割，不会合并在一起。 如果文本对象的矩形（在 中）与指定矩形相交 （在 PDF坐标系中），但其所有字符都位于指定矩形（在 中）外， 则这些文本对象不会被视为指定矩形（在 中）内的分割文本对象。

## ◆ startParse:pause:is_reparse:()

- (FSProgressive *) startParse: |  | (unsigned int) | flags
pause: |  | (id<FSPauseCallback>) | pause
is_reparse: |  | (BOOL) | is_reparse

开始解析当前页面。

解析PDF页面可能需要很长时间，因此Foxit PDF SDK使用渐进式过程来执行此操作。 页面内容的所有资源将在PDF页面解析后加载。
用户可以在不解析页面的情况下获取页面或注释的字典，但要执行 与页面内容相关的操作，请首先解析页面。

参数

  [in] | flags | 解析标志。请参考从FSPDFPageParsePageNormal开始的值， 这应该是这些值中的一个或这些值的组合。 默认值：FSPDFPageParsePageNormal。
  [in] | pause | 暂停回调对象，决定解析过程是否需要暂停。 这可以是nil，表示在解析过程中不暂停。 如果这不是nil，它应该是用户实现的有效暂停对象。 默认值：nil。
  [in] | is_reparse | YES表示重新解析当前页面，NO表示不 重新解析当前页面。默认值：NO。

返回
  渐进式对象。请通过函数FSProgressive::getRateOfProgress检查当前进度的比率。 如果比率还不是100，调用函数FSProgressive::resume继续进度直到进度完成。

注解
  当参数is_reparse设置为YES时，表示重新解析当前PDF页面， 所有检索到的图形对象位置（作为POSITION对象）和图形对象（作为 FSGraphicsObject对象）将变为无效。
  应用程序需要在重新解析PDF页面后重新获取图形对象。

## ◆ transform:need_transform_clip_path:need_transform_annotations:()

- (BOOL) transform: |  | (FSMatrix2D*) | matrix
need_transform_clip_path: |  | (BOOL) | need_transform_clip_path
need_transform_annotations: |  | (BOOL) | need_transform_annotations

转换PDF页面，包括页面上的注释和表单字段。

注解
  此函数仅支持缩放和平移。执行此操作后，请通过函数 FSPDFPage::startParse:pause:is_reparse:重新解析当前页面，参数is_reparse为YES， 以便显示预期的内容。

参数

  [in] | matrix | 转换矩阵。
  [in] | need_transform_clip_path | YES表示转换页面时包含剪切矩形， NO表示不包含。
  [in] | need_transform_annotations | YES表示转换页面时包含注释， NO表示不包含。

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

## ◆ updateAnnotList()

- (void) updateAnnotList |  |  |

更新注释列表。

如果通过直接更改"Annots"字典项来修改（添加/删除...）任何注释， 请在更改后调用此函数来更新注释列表。

返回
  无。

## 属性说明

## ◆ userUnitSize

- (float) userUnitSize
| read write nonatomic assign

获取用户单位。

一个正数，给出默认用户空间单位的大小，以1/72英寸的倍数表示。 支持值的范围取决于实现。