IDIDocument.GetStructTreeRoot Method

The GetStructTreeRoot method returns an object representing the root node of the structure tree. This node is not visible from viewer applications; it only serves as a starting point for creation of the structure tree. Whenever a PDF file is loaded, if it contains Marked Content elements that are not referenced in the structure tree, they will be added automatically to the root node.

 

Syntax

ActiveX:

IStructElement GetStructTreeRoot()

 

Return Value

TObject instance representing the root node of the structure tree in the current document.

 

A Structure Tree node will not be visible in viewer applications unless the node contains at least one user property and a non-empty textual name is assigned to it. See AddUserProperty method and Name property in IStructElement interface for details.

 

 

Example

Please check this link.

 

Remarks

 

Member of CDIntfEx.IDIDocument.