Foxit PDF SDK

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

## 构造函数
(unsigned int) | - getAttributeValueARGB:index:
| 获取指定属性类型的ARGB值（由索引指定）。 更多...
(int) | - getAttributeValueCount:
| 获取指定属性类型的值数量。 更多...
(FSLRStructureElement *) | - getAttributeValueElement:index:
| 获取指定属性类型的结构元素对象（由索引指定）。 更多...
(FSLRStructureElementAttributeValueEnum) | - getAttributeValueEnum:index:
| 获取指定属性类型的枚举值（由索引指定）。 更多...
(float) | - getAttributeValueFloat:index:
| 获取指定属性类型的浮点值（由索引指定）。 更多...
(int) | - getAttributeValueInt32:index:
| 获取指定属性类型的整数值（由索引指定）。 更多...
(NSString *) | - getAttributeValueString:index:
| 获取指定属性类型的字符串值（由索引指定）。 更多...
(FSLRStructureElementAttributeValueType) | - getAttributeValueType:
| 获取指定属性类型的属性值类型。 更多...
(FSRectF *) | - getBBox
| 获取边界框。 更多...
(FSLRElement *) | - getChild:
| 通过索引获取子元素。 更多...
(int) | - getChildCount
| 获取子元素的数量。 更多...
(FSLRStructureElement *) | - getParentElement
| 获取父元素。 更多...
(FSLRStructureElementAttributeType) | - getSupportedAttribute:
| 通过索引获取支持的属性类型。 更多...
(int) | - getSupportedAttributeCount
| 获取支持的属性数量。 更多...
(id) | - initWithElement:
| 构造函数，使用父类对象。 更多...
(id) | - initWithOther:
| 带参数的构造函数。 更多...
构造函数 继承自 FSLRElement
(FSLRElementElementType) | - getElementType
| 获取元素类型。 更多...
(id) | - initWithOther:
| 带参数的构造函数。 更多...
(BOOL) | - isContentElement
| 检查当前对象是否为内容元素。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...
(BOOL) | - isGraphicsObjectElement
| 检查当前对象是否为图形对象元素。 更多...
(BOOL) | - isStructureElement
| 检查当前对象是否为结构元素。 更多...
(NSString *) | - stringifyType
| 将当前元素的类型（枚举值）转换为简短且易记的字符串（文本）表示。 更多...

## 类方法
(BOOL) | + isArrayAttributeValueType:
| 检查输入的属性值类型是否表示数组。 更多...
(FSLRStructureElementAttributeType) | + parseAttributeType:
| 解析属性类型的字符串表示并获取此属性类型的枚举值。 更多...
(NSString *) | + stringifyAttributeType:
| 将指定属性类型的枚举值转换为简短且易记的字符串（文本）表示。 更多...
(NSString *) | + stringifyEnumVariant:
| 将指定属性值枚举的枚举值转换为简短且易记的字符串（文本）表示。 更多...
类方法 继承自 FSLRElement
(NSString *) | + stringifyElementType:
| 将指定元素类型的枚举值转换为简短且易记的字符串（文本）表示。 更多...

## 详细描述

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

## 函数文档

## ◆ getAttributeValueARGB:index:()

- (unsigned int) getAttributeValueARGB: |  | (FSLRStructureElementAttributeType) | type
index: |  | (int) | index

获取指定属性类型的ARGB值（由索引指定）。

此函数适用于值类型为 FSLRStructureElementAttributeValueTypeARGB 或 FSLRStructureElementAttributeValueTypeARGBArray 的属性。对于其他值类型，此函数将返回 0。

参数

  [in] | type | 属性类型。请参考从 FSLRStructureElementAttributeTypeRole 开始的值，应该是这些值中的一个。
  [in] | index | 指定要检索哪个值的索引。有效范围：从 0 到（count-1）。 count 由函数 FSLRStructureElement::getAttributeValueCount: 返回。

返回
  ARGB值。

## ◆ getAttributeValueCount:()

- (int) getAttributeValueCount: |  | (FSLRStructureElementAttributeType) | type |

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

- 当属性类型的值类型表示数组时，此函数返回数组的大小。
- 当属性类型的值类型不表示数组时，此函数将始终返回1。

参数

  [in] | type | 属性类型。请参考从 FSLRStructureElementAttributeTypeRole 开始的值，应该是这些值中的一个。

返回
  指定属性类型的值数量。

## ◆ getAttributeValueElement:index:()

- (FSLRStructureElement *) getAttributeValueElement: |  | (FSLRStructureElementAttributeType) | type
index: |  | (int) | index

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

此函数适用于值类型为 FSLRStructureElementAttributeValueTypeElement 或 FSLRStructureElementAttributeValueTypeElementArray 的属性。对于其他值类型，此函数将返回一个结构元素， 其函数 LRStructureElement::IsEmpty 返回 YES。

参数

  [in] | type | 属性类型。请参考从 FSLRStructureElementAttributeTypeRole 开始的值，应该是这些值中的一个。
  [in] | index | 指定要检索哪个值的索引。有效范围：从 0 到（count-1）。 count 由函数 FSLRStructureElement::getAttributeValueCount: 返回。

返回
  结构元素。

## ◆ getAttributeValueEnum:index:()

- (FSLRStructureElementAttributeValueEnum) getAttributeValueEnum: |  | (FSLRStructureElementAttributeType) | type
index: |  | (int) | index

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

此函数适用于值类型为 FSLRStructureElementAttributeValueTypeEnum 或 FSLRStructureElementAttributeValueTypeEnumArray 的属性。对于其他值类型，此函数将返回 FSLRStructureElementAttributeValueEnumInvalid。

参数

  [in] | type | 属性类型。请参考从 FSLRStructureElementAttributeTypeRole 开始的值，应该是这些值中的一个。
  [in] | index | 指定要检索哪个值的索引。有效范围：从 0 到（count-1）。 count 由函数 FSLRStructureElement::getAttributeValueCount: 返回。

返回
  枚举值。请参考从 FSLRStructureElementAttributeValueEnumInvalid 开始的值，这将是这些值中的一个。

## ◆ getAttributeValueFloat:index:()

- (float) getAttributeValueFloat: |  | (FSLRStructureElementAttributeType) | type
index: |  | (int) | index

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

此函数适用于值类型为 FSLRStructureElementAttributeValueTypeFloat 或 FSLRStructureElementAttributeValueTypeFloatArray 的属性。对于其他值类型，此函数将返回 0.0。

参数

  [in] | type | 属性类型。请参考从 FSLRStructureElementAttributeTypeRole 开始的值，应该是这些值中的一个。
  [in] | index | 指定要检索哪个值的索引。有效范围：从 0 到（count-1）。 count 由函数 FSLRStructureElement::getAttributeValueCount: 返回。

返回
  浮点值。

## ◆ getAttributeValueInt32:index:()

- (int) getAttributeValueInt32: |  | (FSLRStructureElementAttributeType) | type
index: |  | (int) | index

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

此函数适用于值类型为 FSLRStructureElementAttributeValueTypeInt32 或 FSLRStructureElementAttributeValueTypeInt32Array 的属性。对于其他值类型，此函数将返回 0。

参数

  [in] | type | 属性类型。请参考从 FSLRStructureElementAttributeTypeRole 开始的值，应该是这些值中的一个。
  [in] | index | 指定要检索哪个值的索引。有效范围：从 0 到（count-1）。 count 由函数 FSLRStructureElement::getAttributeValueCount: 返回。

返回
  整数值。

## ◆ getAttributeValueString:index:()

- (NSString *) getAttributeValueString: |  | (FSLRStructureElementAttributeType) | type
index: |  | (int) | index

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

此函数适用于值类型为 FSLRStructureElementAttributeValueTypeWStr 或 FSLRStructureElementAttributeValueTypeWStrArray 的属性。对于其他值类型，此函数将返回空字符串。

参数

  [in] | type | 属性类型。请参考从 FSLRStructureElementAttributeTypeRole 开始的值，应该是这些值中的一个。
  [in] | index | 指定要检索哪个值的索引。有效范围：从 0 到（count-1）。 count 由函数 FSLRStructureElement::getAttributeValueCount: 返回。

返回
  宽字符串值。

## ◆ getAttributeValueType:()

- (FSLRStructureElementAttributeValueType) getAttributeValueType: |  | (FSLRStructureElementAttributeType) | type |

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

参数

  [in] | type | 属性类型。请参考从 FSLRStructureElementAttributeTypeRole 开始的值，应该是这些值中的一个。

返回
  指定属性类型的值类型。请参考从 FSLRStructureElementAttributeValueTypeEmpty 开始的值，这将是这些值中的一个。

## ◆ getBBox()

- (FSRectF *) getBBox |  |  |

获取边界框。

返回
  边界框。

## ◆ getChild:()

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

通过索引获取子元素。

参数

  [in] | index | 要检索的子元素的索引。有效范围：从 0 到（count-1）。 count 由函数 FSLRStructureElement::getChildCount 返回。

返回
  子元素。

## ◆ getChildCount()

- (int) getChildCount |  |  |

获取子元素的数量。

返回
  子元素数量。

## ◆ getParentElement()

- (FSLRStructureElement *) getParentElement |  |  |

获取父元素。

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

## ◆ getSupportedAttribute:()

- (FSLRStructureElementAttributeType) getSupportedAttribute: |  | (int) | index |

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

参数

  [in] | index | 要获取类型的支持属性的索引。有效范围：从0到(count-1)。 count由函数FSLRStructureElement::getSupportedAttributeCount返回。

返回
  由索引指定的属性的属性类型。

## ◆ getSupportedAttributeCount()

- (int) getSupportedAttributeCount |  |  |

获取支持的属性数量。

返回
  支持的属性数量。

## ◆ initWithElement:()

- (id) initWithElement: |  | (FSLRElement*) | element |

构造函数，使用父类对象。

参数

  [in] | element | 父类对象。

## ◆ initWithOther:()

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

带参数的构造函数。

参数

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

## ◆ isArrayAttributeValueType:()

+ (BOOL) isArrayAttributeValueType: |  | (FSLRStructureElementAttributeValueType) | type |

检查输入的属性值类型是否表示数组。

参数

  [in] | type | 属性值类型。请参考从FSLRStructureElementAttributeValueTypeEmpty开始的值， 这应该是这些值中的一个。

返回
  YES表示输入类型表示数组，NO表示输入类型不表示数组。

## ◆ parseAttributeType:()

+ (FSLRStructureElementAttributeType) parseAttributeType: |  | (NSString *) | type_string |

解析属性类型的字符串表示并获取此属性类型的枚举值。

参数

  [in] | type_string | 结构元素属性类型的字符串表示。

返回
  属性类型的枚举值。请参考从FSLRStructureElementAttributeTypeInvalid开始的值， 这将是这些值中的一个。

## ◆ stringifyAttributeType:()

+ (NSString *) stringifyAttributeType: |  | (FSLRStructureElementAttributeType) | type |

将指定属性类型的枚举值转换为简短且易记的字符串（文本）表示。

参数

  [in] | type | 指定属性类型的枚举值。请参考从FSLRStructureElementAttributeTypeInvalid开始的值， 这应该是这些值中的一个。

返回
  表示指定类型的简短且易记的字符串表示。 如果没有简短且易记的字符串表示，或输入类型是FSLRStructureElementAttributeTypeInvalid 或无效的枚举值，此函数将返回空字符串。

## ◆ stringifyEnumVariant:()

+ (NSString *) stringifyEnumVariant: |  | (FSLRStructureElementAttributeValueEnum) | type |

将指定属性值枚举的枚举值转换为简短且易记的字符串（文本）表示。

参数

  [in] | type | 指定属性值枚举的枚举值。请参考从 FSLRStructureElementAttributeValueEnumInvalid开始的值，这应该是这些值中的一个。

返回
  表示指定枚举的简短且易记的字符串表示。 如果没有简短且易记的字符串表示，或输入枚举值是FSLRStructureElementAttributeValueEnumInvalid 或无效的枚举值，此函数将返回空字符串。