Foxit PDF SDK

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

## 构造函数
(FSStructTreeEntity *) | - getChild:
| 通过索引获取子结构树实体。 更多...
(int) | - getChildCount
| 获取当前结构元素中子结构树实体的数量。 更多...
(NSString *) | - getElementInfo:
| 获取结构元素信息。 更多...
(FSStructElement *) | - getParentElement
| 获取父结构元素。 更多...
(NSString *) | - getStructureTypeName
| 获取结构类型名称。 更多...
(BOOL) | - hasElementInfo:
| 检查特定类型的结构元素信息是否存在。 更多...
(id) | - init
| 构造函数。
(id) | - initWithOther:
| 拷贝构造函数。 更多...
(void) | - removeChild:
| 通过索引删除子结构树实体。 更多...
构造函数 继承自 FSStructTreeEntity
(FSPDFPage *) | - getPage
| 获取相关的PDF页面。 更多...
(FSStructTreeEntityStructTreeEntityType) | - getType
| 获取结构树实体类型。 更多...
(id) | - initWithOther:
| 拷贝构造函数。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...

## 详细描述

此类表示结构元素。

## 函数文档

## ◆ getChild:()

- (FSStructTreeEntity *) getChild: |  | (int) | index |

通过索引获取子结构树实体。

参数

  [in] | index | 要检索的子结构树实体的索引。有效范围：从0到(count-1)。 count由函数FSStructElement::getChildCount返回。

返回
  一个子结构树实体对象。

## ◆ getChildCount()

- (int) getChildCount |  |  |

获取当前结构元素中子结构树实体的数量。

返回
  子结构树实体的数量。

## ◆ getElementInfo:()

- (NSString *) getElementInfo: |  | (FSStructElementElementInfoType) | type |

获取结构元素信息。

在获取结构元素信息之前，请确保已调用函数FSStructElement::hasElementInfo: 并返回true（使用相应的类型）。

参数

  [in] | type | 结构元素信息类型。请参考从FSStructElementElementInfoTypeTitle开始的值， 这应该是这些值中的一个。

返回
  结构元素信息字符串。

## ◆ getParentElement()

- (FSStructElement *) getParentElement |  |  |

获取父结构元素。

返回
  父结构元素。如果返回对象的函数StructElement::IsEmpty返回YES， 这意味着当前元素没有父元素。

## ◆ getStructureTypeName()

- (NSString *) getStructureTypeName |  |  |

获取结构类型名称。

每个结构元素都应该有一个结构类型，这是一个名称对象，用于标识 结构元素的性质及其在文档中的角色（例如章节、段落或脚注）。 有关更多详细信息，请参考<PDF Reference 1.7>第10.7.3节中对"标准结构类型"的描述或 <PDF Reference 2.0>第14.8.4节中对"标准结构类型"的描述。

返回
  表示当前结构元素的结构类型名称的字符串。

## ◆ hasElementInfo:()

- (BOOL) hasElementInfo: |  | (FSStructElementElementInfoType) | type |

检查特定类型的结构元素信息是否存在。

参数

  [in] | type | 结构元素信息类型。请参考从FSStructElementElementInfoTypeTitle开始的值， 这应该是这些值中的一个。

返回
  YES表示元素信息类型有元素信息， 而NO表示元素信息类型没有元素信息。

## ◆ initWithOther:()

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

拷贝构造函数。

参数

  [in] | other | 另一个结构元素对象。

## ◆ removeChild:()

- (void) removeChild: |  | (int) | index |

通过索引删除子结构树实体。

参数

  [in] | index | 要检索的子结构树实体的索引。有效范围：从0到(count-1)。 count由函数FSStructElement::getChildCount返回。

返回
  无。