Foxit PDF SDK

构造函数 | 所有成员列表
FSMarkedContent类 参考

继承自 NSObject .

## 构造函数
(int) | - addItem:property_dict:
| 添加新的标记内容项。 更多...
(int) | - getItemCount
| 获取标记内容项的数量。 更多...
(int) | - getItemMCID:
| 根据索引获取指定标记内容项的标记内容标识符(MCID)。 更多...
(FSPDFDictionary *) | - getItemPropertyDict:
| 根据索引获取指定标记内容项的属性字典。 更多...
(NSString *) | - getItemTagName:
| 根据索引获取指定标记内容项的标签名称。 更多...
(BOOL) | - hasTag:
| 检查当前标记内容对象是否具有指定的标记内容项。 更多...
(BOOL) | - removeItem:
| 根据标签名称删除标记内容项。 更多...

## 详细描述

标记内容操作符(PDF 1.2)将PDF内容流的一部分标识为特定应用程序或PDF插件扩展感兴趣的标记内容元素。 更多详细信息，请参阅<PDF Reference 1.7>第10.5节"标记内容"。
要获取标记内容对象，请使用函数FSGraphicsObject::getMarkedContent。

参见
  FSGraphicsObject

## 函数文档

## ◆ addItem:property_dict:()

- (int) addItem: |  | (NSString *) | tag_name
property_dict: |  | (FSPDFDictionary*) | property_dict

添加新的标记内容项。

参数

  [in] | tag_name | 新的标签名称。它不应该是空字符串。 如果参数tag_name在当前标记内容对象中存在， 则不能再次添加到当前标记内容对象中。
  [in] | property_dict | 属性字典。默认值：nil。 nil 表示新的标记内容项将没有属性字典。 如果此字典是新创建的且尚未设置给其他对象，用户应在调用此函数后释放此字典对象。

返回
  新添加的标记内容项的索引。如果有任何错误，此函数将返回-1。

## ◆ getItemCount()

- (int) getItemCount |  |  |

获取标记内容项的数量。

标记内容对象可能一个嵌套在另一个内部，此函数用于获取当前标记内容序列中标记内容项的数量。

返回
  标记内容项的数量。

## ◆ getItemMCID:()

- (int) getItemMCID: |  | (int) | index |

根据索引获取指定标记内容项的标记内容标识符(MCID)。

参数

  [in] | index | 项索引。有效范围：从0到(count-1)。 count 由函数FSMarkedContent::getItemCount返回。

返回
  MCID值。负数表示指定的标记内容项没有MCID。

## ◆ getItemPropertyDict:()

- (FSPDFDictionary *) getItemPropertyDict: |  | (int) | index |

根据索引获取指定标记内容项的属性字典。

参数

  [in] | index | 项索引。有效范围：从0到(count-1)。 count 由函数FSMarkedContent::getItemCount返回。

返回
  属性字典。nil 表示没有属性字典。

## ◆ getItemTagName:()

- (NSString *) getItemTagName: |  | (int) | index |

根据索引获取指定标记内容项的标签名称。

标记内容对象可能一个嵌套在另一个内部，此函数用于获取当前标记内容序列中标记内容项的数量。

参数

  [in] | index | 项索引。有效范围：从0到(count-1)。 count 由函数FSMarkedContent::getItemCount返回。

返回
  标签名称。

## ◆ hasTag:()

- (BOOL) hasTag: |  | (NSString *) | tag_name |

检查当前标记内容对象是否具有指定的标记内容项。

参数

  [in] | tag_name | 要检查的标签名称。

返回
  YES 表示当前标记内容对象具有指定的标记内容项。 NO 表示当前标记内容对象不具有指定的标记内容项。

## ◆ removeItem:()

- (BOOL) removeItem: |  | (NSString *) | tag_name |

根据标签名称删除标记内容项。

参数

  [in] | tag_name | 标签名称。不应为空字符串。

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