Foxit PDF SDK
|
Public Types | |
enum | ElementInfoType { ElementInfoType.e_ElementInfoTypeTitle = 0, ElementInfoType.e_ElementInfoTypeLanguage = 1, ElementInfoType.e_ElementInfoTypeAltDescription = 2, ElementInfoType.e_ElementInfoTypeExpandedForm = 3, ElementInfoType.e_ElementInfoTypeActualText = 4 } |
Enumeration for structure element info type. More... | |
![]() | |
enum | StructTreeEntityType { StructTreeEntityType.e_UnknownType = -1, StructTreeEntityType.e_StructTreeEntityTypeElement = 0, StructTreeEntityType.e_StructTreeEntityTypeMarkedContent = 1, StructTreeEntityType.e_StructTreeEntityTypeObjectContent = 2 } |
Enumeration for structure tree entity type. More... | |
Public Member Functions | |
StructElement () | |
Constructor. | |
StructTreeEntity | GetChild (int index) |
Get a child structure tree entity by index. More... | |
int | GetChildCount () |
Get the count of child structure tree entities in the current structure element. More... | |
string | GetElementInfo (StructElement.ElementInfoType type) |
Get the structure element information. More... | |
StructElement | GetParentElement () |
Get the parent structure element. More... | |
string | GetStructureTypeName () |
Get structure type name. More... | |
bool | HasElementInfo (StructElement.ElementInfoType type) |
Check whether the structure element information of a specific type exist. More... | |
![]() | |
StructTreeEntity () | |
Constructor. | |
StructTreeEntity (StructTreeEntity other) | |
Constructor, with another structure element entity object. More... | |
PDFPage | GetPage () |
Get the related PDF page. More... | |
StructTreeEntity.StructTreeEntityType | GetType () |
Get structure tree entity type. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
This class represents structure element.
|
strong |
Enumeration for structure element info type.
Values of this enumeration should be used alone.
|
inline |
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 StructElement.GetChildCount . |
|
inline |
Get the count of child structure tree entities in the current structure element.
|
inline |
Get the structure element information.
Before get structure element information, ensure that the function StructElement.HasElementInfo has been called and returned true (using the corresponding type).
[in] | type | Structure element information type. Please refer to values starting from foxit.pdf.objects.StructElement.ElementInfoType.e_ElementInfoTypeTitle and this would be one of these values. |
|
inline |
Get the parent structure element.
|
inline |
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.
|
inline |
Check whether the structure element information of a specific type exist.
[in] | type | Structure element information type. Please refer to values starting from foxit.pdf.objects.StructElement.ElementInfoType.e_ElementInfoTypeTitle and this would be one of these values. |