|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetChild (index) |
| Get a child structure tree entity by index. More... | |
| def | GetChildCount () |
| Get the count of child structure tree entities in the current structure element. More... | |
| def | GetElementInfo (type) |
| Get the structure element information. More... | |
| def | GetParentElement () |
| Get the parent structure element. More... | |
| def | GetStructureTypeName () |
| Get structure type name. More... | |
| def | HasElementInfo (type) |
| Check whether the structure element information of a specific type exist. More... | |
This class represents structure element.
| def fsdk.StructElement.GetChild | ( | index | ) |
Get a child structure tree entity by index.
| [in] | index | Index of a child structure tree entity to be retrieved. Valid range: from 0 to (count-1). count is returned by function fsdk.StructElement.GetChildCount . |
| def fsdk.StructElement.GetChildCount | ( | ) |
Get the count of child structure tree entities in the current structure element.
| def fsdk.StructElement.GetElementInfo | ( | type | ) |
Get the structure element information.
Before get structure element information, ensure that the function fsdk.StructElement.HasElementInfo has been called and returned true (using the corresponding type).
| [in] | type | Structure element information type. Please refer to values starting from fsdk.StructElementE_ElementInfoTypeTitle and this would be one of these values. |
| def fsdk.StructElement.GetParentElement | ( | ) |
Get the parent structure element.
| def fsdk.StructElement.GetStructureTypeName | ( | ) |
Get structure type name.
Every structure element shall have a structure type, a name object that identifies the nature of the structure element and its role within the document (such as a chapter, paragraph, or footnote). Please refer to the description of "Standard Structure Types" in Section 10.7.3 of <PDF Reference 1.7> or the description of "Standard structure types" in Section 14.8.4 of <PDF Reference 2.0> for more details.
| def fsdk.StructElement.HasElementInfo | ( | type | ) |
Check whether the structure element information of a specific type exist.
| [in] | type | Structure element information type. Please refer to values starting from fsdk.StructElementE_ElementInfoTypeTitle and this would be one of these values. |