StructTreeRoot Class Documentation
classStructTreeRoot : SystemIDisposableNamespace:Datalogics::PDFL
- Inherits from:
SystemIDisposable
Detailed Description
Internal wrapper for the root of a PDF logical structure tree.
Owns a non-owning reference to its CDocument. The underlying PDF structure tree is owned by the document; this wrapper provides C++ access to catalog-level struct tree operations (add children, access the backing dict).
Referenced by
Uses types
Constructor & Destructor Documentation
StructTreeRoot
StructTreeRoot(StructTreeRootrhs, InternalConstructsignifier)Parameters
rhs: StructTreeRootsignifier: InternalConstruct
~StructTreeRoot
~StructTreeRoot()Property Documentation
Document
DocumentDocument[get]KidCount
intKidCount[get]PDFDict
PDFDictPDFDict[get]Member Function Documentation
AddChild
StructElementAddChild(stringstructType)Parameters
structType: string
Returns:
StructElementConstructorRetrieve
static StructTreeRootConstructorRetrieve(System.IntPtrignored)Parameters
ignored: System.IntPtr
Returns:
StructTreeRootDispose
voidDispose()Returns:
voidDisposeChildren
voidDisposeChildren()Returns:
voidFindElementFromID
StructElementFindElementFromID(stringid)Parameters
id: string
Returns:
StructElementElement whose /ID matches id, or nullptr if none exists.
GetKid
StructElementGetKid(intindex)Parameters
index: int
Returns:
StructElementKid at index. The tree root's /K array is restricted to struct elements (not MCRs / OBJRs), so this always returns an element. Caller owns the returned pointer.