fsdk.StructElement类 参考

Public 成员函数
def	GetChild (index)
	通过索引获取子结构树实体。 更多...
def	GetChildCount ()
	获取当前结构元素中子结构树实体的数量。 更多...
def	GetElementInfo (type)
	获取结构元素信息。 更多...
def	GetParentElement ()
	获取父结构元素。 更多...
def	GetStructureTypeName ()
	获取结构类型名称。 更多...
def	HasElementInfo (type)
	检查特定类型的结构元素信息是否存在。 更多...
def	RemoveChild (index)
	通过索引删除子结构树实体。 更多...

详细描述

此类表示结构元素。

成员函数说明

GetChild()

def fsdk.StructElement.GetChild

(

index

)

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

参数

[in]

index

要检索的子结构树实体的索引。有效范围：从0到(count-1)。 count由函数fsdk.StructElement.GetChildCount 返回。

返回

一个子结构树实体对象。

GetChildCount()

def fsdk.StructElement.GetChildCount

(

)

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

返回

子结构树实体的数量。

GetElementInfo()

def fsdk.StructElement.GetElementInfo

(

type

)

获取结构元素信息。

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

参数

[in]

type

结构元素信息类型。请参考从fsdk.StructElementE_ElementInfoTypeTitle 开始的值， 这应该是这些值中的一个。

返回

结构元素信息字符串。

GetParentElement()

def fsdk.StructElement.GetParentElement

(

)

获取父结构元素。

返回

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

GetStructureTypeName()

def fsdk.StructElement.GetStructureTypeName

(

)

获取结构类型名称。

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

返回

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

HasElementInfo()

def fsdk.StructElement.HasElementInfo

(

type

)

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

参数

[in]

type

结构元素信息类型。请参考从fsdk.StructElementE_ElementInfoTypeTitle 开始的值， 这应该是这些值中的一个。

返回

true表示元素信息类型有元素信息， 而false表示元素信息类型没有元素信息。

RemoveChild()

def fsdk.StructElement.RemoveChild

(

index

)

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

参数

[in]

index

要检索的子结构树实体的索引。有效范围：从0到(count-1)。 count由函数fsdk.StructElement.GetChildCount 返回。

返回

无。