Foxit PDF SDK
fsdk.LRStructureElement类 参考

Public 成员函数

def GetAttributeValueARGB (type, index)
 获取指定属性类型的ARGB值(由索引指定)。 更多...
 
def GetAttributeValueCount (type)
 获取指定属性类型的值数量。 更多...
 
def GetAttributeValueElement (type, index)
 获取指定属性类型的结构元素对象(由索引指定)。 更多...
 
def GetAttributeValueEnum (type, index)
 获取指定属性类型的枚举值(由索引指定)。 更多...
 
def GetAttributeValueFloat (type, index)
 获取指定属性类型的浮点值(由索引指定)。 更多...
 
def GetAttributeValueInt32 (type, index)
 获取指定属性类型的整数值(由索引指定)。 更多...
 
def GetAttributeValueString (type, index)
 获取指定属性类型的字符串值(由索引指定)。 更多...
 
def GetAttributeValueType (type)
 获取指定属性类型的属性值类型。 更多...
 
def GetBBox ()
 获取边界框。 更多...
 
def GetChild (index)
 通过索引获取子元素。 更多...
 
def GetChildCount ()
 获取子元素的数量。 更多...
 
def GetParentElement ()
 获取父元素。 更多...
 
def GetSupportedAttribute (index)
 通过索引获取支持的属性类型。 更多...
 
def GetSupportedAttributeCount ()
 获取支持的属性数量。 更多...
 

详细描述

此类表示结构元素。结构元素可用于构造树,如图形结构元素、段落 结构元素、跨度结构元素等。

成员函数说明

◆ GetAttributeValueARGB()

def fsdk.LRStructureElement.GetAttributeValueARGB (   type,
  index 
)

获取指定属性类型的ARGB值(由索引指定)。

此函数适用于值类型为 fsdk.LRStructureElementE_AttributeValueTypeARGB fsdk.LRStructureElementE_AttributeValueTypeARGBArray 的属性。对于其他值类型,此函数将返回 0。

参数
[in]type属性类型。请参考从 fsdk.LRStructureElementE_AttributeTypeRole 开始的值,应该是这些值中的一个。
[in]index指定要检索哪个值的索引。有效范围:从 0 到(count-1)。 count 由函数 fsdk.LRStructureElement.GetAttributeValueCount 返回。
返回
ARGB值。

◆ GetAttributeValueCount()

def fsdk.LRStructureElement.GetAttributeValueCount (   type)

获取指定属性类型的值数量。

  • 当属性类型的值类型表示数组时,此函数返回数组的大小。

  • 当属性类型的值类型不表示数组时,此函数将始终返回1。

参数
[in]type属性类型。请参考从 fsdk.LRStructureElementE_AttributeTypeRole 开始的值,应该是这些值中的一个。
返回
指定属性类型的值数量。

◆ GetAttributeValueElement()

def fsdk.LRStructureElement.GetAttributeValueElement (   type,
  index 
)

获取指定属性类型的结构元素对象(由索引指定)。

此函数适用于值类型为 fsdk.LRStructureElementE_AttributeValueTypeElement fsdk.LRStructureElementE_AttributeValueTypeElementArray 的属性。对于其他值类型,此函数将返回一个结构元素, 其函数 LRStructureElement::IsEmpty 返回 true

参数
[in]type属性类型。请参考从 fsdk.LRStructureElementE_AttributeTypeRole 开始的值,应该是这些值中的一个。
[in]index指定要检索哪个值的索引。有效范围:从 0 到(count-1)。 count 由函数 fsdk.LRStructureElement.GetAttributeValueCount 返回。
返回
结构元素。

◆ GetAttributeValueEnum()

def fsdk.LRStructureElement.GetAttributeValueEnum (   type,
  index 
)

获取指定属性类型的枚举值(由索引指定)。

此函数适用于值类型为 fsdk.LRStructureElementE_AttributeValueTypeEnum fsdk.LRStructureElementE_AttributeValueTypeEnumArray 的属性。对于其他值类型,此函数将返回 fsdk.LRStructureElementE_AttributeValueEnumInvalid

参数
[in]type属性类型。请参考从 fsdk.LRStructureElementE_AttributeTypeRole 开始的值,应该是这些值中的一个。
[in]index指定要检索哪个值的索引。有效范围:从 0 到(count-1)。 count 由函数 fsdk.LRStructureElement.GetAttributeValueCount 返回。
返回
枚举值。请参考从 fsdk.LRStructureElementE_AttributeValueEnumInvalid 开始的值,这将是这些值中的一个。

◆ GetAttributeValueFloat()

def fsdk.LRStructureElement.GetAttributeValueFloat (   type,
  index 
)

获取指定属性类型的浮点值(由索引指定)。

此函数适用于值类型为 fsdk.LRStructureElementE_AttributeValueTypeFloat fsdk.LRStructureElementE_AttributeValueTypeFloatArray 的属性。对于其他值类型,此函数将返回 0.0。

参数
[in]type属性类型。请参考从 fsdk.LRStructureElementE_AttributeTypeRole 开始的值,应该是这些值中的一个。
[in]index指定要检索哪个值的索引。有效范围:从 0 到(count-1)。 count 由函数 fsdk.LRStructureElement.GetAttributeValueCount 返回。
返回
浮点值。

◆ GetAttributeValueInt32()

def fsdk.LRStructureElement.GetAttributeValueInt32 (   type,
  index 
)

获取指定属性类型的整数值(由索引指定)。

此函数适用于值类型为 fsdk.LRStructureElementE_AttributeValueTypeInt32 fsdk.LRStructureElementE_AttributeValueTypeInt32Array 的属性。对于其他值类型,此函数将返回 0。

参数
[in]type属性类型。请参考从 fsdk.LRStructureElementE_AttributeTypeRole 开始的值,应该是这些值中的一个。
[in]index指定要检索哪个值的索引。有效范围:从 0 到(count-1)。 count 由函数 fsdk.LRStructureElement.GetAttributeValueCount 返回。
返回
整数值。

◆ GetAttributeValueString()

def fsdk.LRStructureElement.GetAttributeValueString (   type,
  index 
)

获取指定属性类型的字符串值(由索引指定)。

此函数适用于值类型为 fsdk.LRStructureElementE_AttributeValueTypeWStr fsdk.LRStructureElementE_AttributeValueTypeWStrArray 的属性。对于其他值类型,此函数将返回空字符串。

参数
[in]type属性类型。请参考从 fsdk.LRStructureElementE_AttributeTypeRole 开始的值,应该是这些值中的一个。
[in]index指定要检索哪个值的索引。有效范围:从 0 到(count-1)。 count 由函数 fsdk.LRStructureElement.GetAttributeValueCount 返回。
返回
宽字符串值。

◆ GetAttributeValueType()

def fsdk.LRStructureElement.GetAttributeValueType (   type)

获取指定属性类型的属性值类型。

参数
[in]type属性类型。请参考从 fsdk.LRStructureElementE_AttributeTypeRole 开始的值,应该是这些值中的一个。
返回
指定属性类型的值类型。请参考从 fsdk.LRStructureElementE_AttributeValueTypeEmpty 开始的值,这将是这些值中的一个。

◆ GetBBox()

def fsdk.LRStructureElement.GetBBox ( )

获取边界框。

返回
边界框。

◆ GetChild()

def fsdk.LRStructureElement.GetChild (   index)

通过索引获取子元素。

参数
[in]index要检索的子元素的索引。有效范围:从 0 到(count-1)。 count 由函数 fsdk.LRStructureElement.GetChildCount 返回。
返回
子元素。

◆ GetChildCount()

def fsdk.LRStructureElement.GetChildCount ( )

获取子元素的数量。

返回
子元素数量。

◆ GetParentElement()

def fsdk.LRStructureElement.GetParentElement ( )

获取父元素。

返回
父元素。如果返回对象的函数 LRStructureElement::IsEmpty 返回 true, 表示当前元素没有父元素。

◆ GetSupportedAttribute()

def fsdk.LRStructureElement.GetSupportedAttribute (   index)

通过索引获取支持的属性类型。

参数
[in]index要获取类型的支持属性的索引。有效范围:从0到(count-1)。 count由函数fsdk.LRStructureElement.GetSupportedAttributeCount 返回。
返回
由索引指定的属性的属性类型。

◆ GetSupportedAttributeCount()

def fsdk.LRStructureElement.GetSupportedAttributeCount ( )

获取支持的属性数量。

返回
支持的属性数量。