Foxit PDF SDK
|
Instance Methods | |
(FSStructTreeEntity *) | - getChild: |
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... | |
(NSString *) | - getElementInfo: |
Get the structure element information. More... | |
(FSStructElement *) | - getParentElement |
Get the parent structure element. More... | |
(NSString *) | - getStructureTypeName |
Get structure type name. More... | |
(BOOL) | - hasElementInfo: |
Check whether the structure element information of a specific type exist. More... | |
(id) | - init |
Constructor. | |
(id) | - initWithOther: |
Constructor, with another structure element object. More... | |
![]() | |
(FSPDFPage *) | - getPage |
Get the related PDF page. More... | |
(FSStructTreeEntityStructTreeEntityType) | - getType |
Get structure tree entity type. More... | |
(id) | - initWithOther: |
Constructor, with another structure element entity object. More... | |
(BOOL) | - isEmpty |
Check whether current object is empty or not. More... | |
This class represents structure element.
- (FSStructTreeEntity *) getChild: | (int) | 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 FSStructElement::getChildCount. |
- (int) getChildCount |
Get the count of child structure tree entities in the current structure element.
- (NSString *) getElementInfo: | (FSStructElementElementInfoType) | type |
Get the structure element information.
Before get structure element information, ensure that the function FSStructElement::hasElementInfo: has been called and returned true (using the corresponding type).
[in] | type | Structure element information type. Please refer to values starting from FSStructElementElementInfoTypeTitle and this would be one of these values. |
- (FSStructElement *) getParentElement |
Get the parent structure element.
- (NSString *) 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.
- (BOOL) hasElementInfo: | (FSStructElementElementInfoType) | type |
Check whether the structure element information of a specific type exist.
[in] | type | Structure element information type. Please refer to values starting from FSStructElementElementInfoTypeTitle and this would be one of these values. |
- (id) initWithOther: | (FSStructElement*) | other |
Constructor, with another structure element object.
[in] | other | Another structure element object. |