ReadStructureElements 方法

元件: TPdf · 單元: PDFium

讀取以單一頁面為根的結構樹自主快照

Syntax

function ReadStructureElements(PageNumber: Integer; const Options: TPdfStructureReadOptions; out Status: TPdfStructureReadStatus): TPdfStructureElements;

Description

ReadStructureElements 會走訪 PageNumber（以一為基底）的標籤式結構樹，並傳回自主擁有的 TPdfStructureElements 陣列，其中包含類型、標題、MCID、子項索引與參考資訊

Status 會說明結果為空的原因，區分未加標籤的文件與有界或失敗的讀取

Remarks

先使用 IsTagged 檢查文件是否帶有結構樹
重複讀取會由結構快取提供服務；請參閱 StructureCacheCapacity 與 StructureElementsForPage
對於非常深的樹，建議使用 VisitStructureElements，它以串流方式走訪，而不是具體化整個陣列

Example

var St: TPdfStructureReadStatus;
Elements := Pdf1.ReadStructureElements(1, Default(TPdfStructureReadOptions), St);