Foxit PDF SDK

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

## 构造函数
(float) | - getMeasureConversionFactor:
| 获取用于测量的转换因子。 更多...
(NSString *) | - getMeasureRatioW
| 获取用于测量的比例比率Unicode字符串。 更多...
(NSString *) | - getMeasureUnit:
| 获取用于测量的单位显示标签。 更多...
(NSString *) | - getMeasureUnitW:
| 获取用于测量的单位显示标签（Unicode字符串格式）。 更多...
(id) | - init
| 构造函数。
(id) | - initWithAnnot:
| 构造函数，使用父类对象。 更多...
(void) | - setMeasureConversionFactor:factor:
| 设置用于测量的转换因子。 更多...
(void) | - setMeasureUnit:unit:
| 设置用于测量的单位显示标签。 更多...
构造函数 继承自 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 | fillColor
| 获取填充颜色。 更多...
NSString * | measureRatio
| 获取用于测量的比例比率字符串。 更多...
FSPointFArray * | vertexes
| 获取顶点。 更多...
属性 继承自 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。

## 详细描述

多边形注释在页面上显示一个封闭的多边形。
多边形注释是一种标记注释，所以类FSPolygon 派生自 类FSMarkup ，并且还提供获取/设置多边形注释属性和 重置多边形注释外观流的函数。
对于多边形注释，顶点属性是必需的。因此，请确保多边形注释 在重置其外观流之前具有有效的顶点属性；否则多边形注释无法 重置外观流。

注解
  对于新创建的多边形注释， 如果用户在设置必需的顶点属性后直接调用函数FSAnnot::resetAppearanceStream 而不设置任何其他属性，将使用默认外观：
  边框宽度 = 2.0，边框样式 = FSBorderInfoSolid， 边框颜色 = 0xFFFF0000（红色），不透明度 = 1.0。

参见
  FSMarkup

## 函数文档

## ◆ getMeasureConversionFactor:()

- (float) getMeasureConversionFactor: |  | (FSMarkupMeasureType) | measure_type |

获取用于测量的转换因子。

多边形注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。 有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

  [in] | measure_type | 测量类型。请参考从FSMarkupMeasureTypeX开始的值， 这应该是这些值中的一个。

返回
  转换因子。

## ◆ getMeasureRatioW()

- (NSString *) getMeasureRatioW |  |  |

获取用于测量的比例比率Unicode字符串。

多边形注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。 比例比率字符串表达该区域中绘图的比例比率。 有关更多详细信息，请参考《PDF参考1.7》中的第745页。

返回
  表达比例比率的Unicode字符串。

## ◆ getMeasureUnit:()

- (NSString *) getMeasureUnit: |  | (FSMarkupMeasureType) | measure_type |

获取用于测量的单位显示标签。

多边形注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。 有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

  [in] | measure_type | 测量类型。请参考从FSMarkupMeasureTypeX开始的值， 这应该是这些值中的一个。

返回
  表示显示单位标签的UTF-8文本字符串。

## ◆ getMeasureUnitW:()

- (NSString *) getMeasureUnitW: |  | (FSMarkupMeasureType) | measure_type |

获取用于测量的单位显示标签（Unicode字符串格式）。

多边形注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。 有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

  [in] | measure_type | 测量类型。请参考从FSMarkupMeasureTypeX开始的值， 这应该是这些值中的一个。

返回
  表示显示单位标签的Unicode字符串。

## ◆ initWithAnnot:()

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

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

参数

  [in] | annot | 父类对象。

重载 FSMarkup .

## ◆ setMeasureConversionFactor:factor:()

- (void) setMeasureConversionFactor: |  | (FSMarkupMeasureType) | measure_type
factor: |  | (float) | factor

设置用于测量的转换因子。

多边形注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。 有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

  [in] | measure_type | 测量类型。请参考从FSMarkupMeasureTypeX开始的值， 这应该是这些值中的一个。
  [in] | factor | 转换因子。

返回
  无。

## ◆ setMeasureUnit:unit:()

- (void) setMeasureUnit: |  | (FSMarkupMeasureType) | measure_type
unit: |  | (NSString *) | unit

设置用于测量的单位显示标签。

多边形注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。 有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

  [in] | measure_type | 测量类型。请参考从FSMarkupMeasureTypeX开始的值， 这应该是这些值中的一个。
  [in] | unit | 指定显示单位标签的UTF-8文本字符串。

返回
  无。

## 属性说明

## ◆ fillColor

- (unsigned int) fillColor
| read write nonatomic assign

获取填充颜色。

此属性对多边形注释的外观有影响。

## ◆ measureRatio

- (NSString *) measureRatio
| read write nonatomic weak

获取用于测量的比例比率字符串。

多边形注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。 比例比率字符串表达该区域中绘图的比例比率。 有关更多详细信息，请参考《PDF参考1.7》中的第745页。

## ◆ vertexes

- (FSPointFArray *) vertexes
| read write nonatomic weak

获取顶点。

顶点属性对于多边形注释是必需的，此属性对多边形 注释的外观有影响。