StructTreeRoot Class

class StructTreeRoot : SystemIDisposable

Namespace: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

Document

Uses types

Document PDFDict StructElement

Property Documentation

Document Document[get]

int KidCount[get]

PDFDict PDFDict[get]

Member Function Documentation

StructElement AddChild(string structType)

Parameters

structType: string

Returns:

StructElement

void Dispose()

Returns:

void

StructElement FindElementFromID(string id)

Parameters

id: string

Returns:

StructElement

Element whose /ID matches id, or nullptr if none exists.

StructElement GetKid(int index)

Parameters

index: int

Returns:

StructElement

Kid 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.