Foxit PDF SDK

Public 成员函数 | 所有成员列表
FSDK::MarkedContent类 参考

## Public 成员函数
| AddItem (tag_name, property_dict)
| 添加新的标记内容项。 更多...
| GetItemCount ()
| 获取标记内容项的数量。 更多...
| GetItemMCID (index)
| 获取由索引指定的标记内容项的标记内容标识符（MCID）。 更多...
| GetItemPropertyDict (index)
| 获取由索引指定的标记内容项的属性字典。 更多...
| GetItemTagName (index)
| 获取由索引指定的标记内容项的标签名称。 更多...
| HasTag (tag_name)
| 检查当前标记内容对象是否具有指定的标记内容项。 更多...
| RemoveItem (tag_name)
| 通过标签名称删除标记内容项。 更多...

## 详细描述

标记内容操作符（PDF 1.2）将 PDF 内容流的一部分标识为对特定应用程序或 PDF 插件扩展有兴趣的标记内容元素。有关更多详细信息，请参阅 <PDF Reference 1.7> 中的第 10.5 节“标记内容”。
要获取标记内容对象，请使用函数 FSDK.GraphicsObject.GetMarkedContent。

参见
  FSDK.GraphicsObject

## 成员函数说明

## ◆ AddItem()

FSDK::MarkedContent::AddItem | ( | tag_name | ,
|  | property_dict |
| ) |  |

添加新的标记内容项。

参数

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

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

## ◆ GetItemCount()

FSDK::MarkedContent::GetItemCount | ( |  | ) |

获取标记内容项的数量。

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

返回
  标记内容项的数量。

## ◆ GetItemMCID()

FSDK::MarkedContent::GetItemMCID | ( | index |  | ) |

获取由索引指定的标记内容项的标记内容标识符（MCID）。

参数

  [in] | index | 项索引。有效范围：从 0 到 (count-1)。 count 由函数FSDK.MarkedContent.GetItemCount 返回。

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

## ◆ GetItemPropertyDict()

FSDK::MarkedContent::GetItemPropertyDict | ( | index |  | ) |

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

参数

  [in] | index | 项索引。有效范围：从 0 到 (count-1)。 count 由函数FSDK.MarkedContent.GetItemCount 返回。

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

## ◆ GetItemTagName()

FSDK::MarkedContent::GetItemTagName | ( | index |  | ) |

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

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

参数

  [in] | index | 项索引。有效范围：从 0 到 (count-1)。 count 由函数FSDK.MarkedContent.GetItemCount 返回。

返回
  标签名称。

## ◆ HasTag()

FSDK::MarkedContent::HasTag | ( | tag_name |  | ) |

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

参数

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

返回
  true 表示当前标记内容对象具有指定的标记内容项。 false 表示当前标记内容对象没有指定的标记内容项。

## ◆ RemoveItem()

FSDK::MarkedContent::RemoveItem | ( | tag_name |  | ) |

通过标签名称删除标记内容项。

参数

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

返回
  true 表示成功，而 false 表示失败。