FSDK::StructElement类 参考
类 FSDK::StructElement 继承关系图:
Public 成员函数 | |
| constructor () | |
| 构造函数。 | |
| GetChild (index) | |
| 按索引获取子结构树实体。 更多... | |
| GetChildCount () | |
| 获取当前结构元素中子结构树实体的数量。 更多... | |
| GetElementInfo (type) | |
| 获取结构元素信息。 更多... | |
| GetParentElement () | |
| 获取父结构元素。 更多... | |
| GetStructureTypeName () | |
| 获取结构类型名称。 更多... | |
| HasElementInfo (type) | |
| 检查特定类型的结构元素信息是否存在。 更多... | |
| RemoveChild (index) | |
| 按索引移除子结构树实体。 更多... | |
 Public 成员函数 继承自 FSDK::StructTreeEntity | |
| constructor () | |
| 构造函数。 | |
| GetPage () | |
| 获取相关的PDF页面。 更多... | |
| GetType () | |
| 获取结构树实体类型。 更多... | |
| IsEmpty () | |
| 检查当前对象是否为空。 更多... | |
静态 Public 属性 | |
| static | e_ElementInfoTypeActualText |
| 结构元素信息类型：实际文本，表示结构元素的实际文本。 | |
| static | e_ElementInfoTypeAltDescription |
| 结构元素信息类型：替代描述，表示结构元素的替代描述。 | |
| static | e_ElementInfoTypeExpandedForm |
| 结构元素信息类型：扩展形式，表示结构元素的扩展形式。 | |
| static | e_ElementInfoTypeLanguage |
| 结构元素信息类型：语言，表示结构元素中所有文本的自然语言， 除非被嵌套结构元素或标记内容的语言规范覆盖。 | |
| static | e_ElementInfoTypeTitle |
| 结构元素信息类型枚举。 更多... | |
| 静态 Public 属性 继承自 FSDK::StructTreeEntity | |
| static | e_StructTreeEntityTypeElement |
| 结构树实体类型：元素,表示一个结构元素。 | |
| static | e_StructTreeEntityTypeMarkedContent |
| 结构树实体类型：标记内容,表示一个标记内容项。 | |
| static | e_StructTreeEntityTypeObjectContent |
| 结构树实体类型：对象内容,表示一个PDF对象内容项, 例如注释和XObject。 | |
| static | e_UnknownType |
| 结构树实体类型的枚举。 更多... | |
详细描述
此类表示结构元素。
成员函数说明
◆ GetChild()
| FSDK::StructElement::GetChild | ( | index | ) |
按索引获取子结构树实体。
- 参数
-
[in] index 要检索的子结构树实体的索引。有效范围：从 0 到 (count-1)。 count 由函数 FSDK.StructElement.GetChildCount 返回。
- 返回
- 子结构树实体对象。
◆ GetChildCount()
| FSDK::StructElement::GetChildCount | ( | ) |
获取当前结构元素中子结构树实体的数量。
- 返回
- 子结构树实体的数量。
◆ GetElementInfo()
| FSDK::StructElement::GetElementInfo | ( | type | ) |
获取结构元素信息。
在获取结构元素信息之前，请确保已调用函数 FSDK.StructElement.HasElementInfo 并返回 true（使用相应的类型）。
- 参数
-
[in] type 结构元素信息类型。请参考从 FSDK.StructElement.e_ElementInfoTypeTitle 开始的值， 这将是这些值之一。
- 返回
- 结构元素信息字符串。
◆ GetParentElement()
| FSDK::StructElement::GetParentElement | ( | ) |
获取父结构元素。
- 返回
- 父结构元素。如果返回对象的函数 FSDK.StructElement.IsEmpty 返回 true， 表示当前元素没有父元素。
◆ GetStructureTypeName()
| FSDK::StructElement::GetStructureTypeName | ( | ) |
获取结构类型名称。
每个结构元素都应具有结构类型，即标识 结构元素的性质及其在文档中的作用（例如章节、段落或脚注）的名称对象。 有关更多详细信息，请参阅《PDF Reference 1.7》第 10.7.3 节中"标准结构类型"的描述， 或《PDF Reference 2.0》第 14.8.4 节中"标准结构类型"的描述。
- 返回
- 表示当前结构元素的结构类型名称的字符串。
◆ HasElementInfo()
| FSDK::StructElement::HasElementInfo | ( | type | ) |
检查特定类型的结构元素信息是否存在。
- 参数
-
[in] type 结构元素信息类型。请参考从 FSDK.StructElement.e_ElementInfoTypeTitle 开始的值， 这将是这些值之一。
- 返回
- true 表示该元素信息类型具有元素信息， 而 false 表示该元素信息类型不具有元素信息。
◆ RemoveChild()
| FSDK::StructElement::RemoveChild | ( | index | ) |
按索引移除子结构树实体。
- 参数
-
[in] index 要检索的子结构树实体的索引。有效范围：从 0 到 (count-1)。 count 由函数 FSDK.StructElement.GetChildCount 返回。
- 返回
- 无。
类成员变量说明
◆ e_ElementInfoTypeTitle
|
static |
结构元素信息类型枚举。
此枚举的值应单独使用。结构元素信息类型：标题，表示结构元素的标题。以人类可读形式表示的文本字符串。
