AddTextMarkupFromSearchHits

註解與熱點連結

Description

Hits 中的每個矩形加入一個文字標記註解,把 SearchTextSearchTextEachSearchTextBatchGetTextInAreaEx 傳回的任何命中陣列直接變成標記註解,不必自己逐一跑 AddTextMarkupAnnotation

每個命中矩形若 Page 超出文件的頁面範圍,或 Right/Bottom 沒有超過 Left/Top,都會被跳過。存留下來的矩形會在加入註解前暫時選取該命中的頁面;呼叫開始時選取的頁面一定會在返回前還原,就算命中橫跨好幾頁也一樣

語法

Delphi

Function TPDFlib.AddTextMarkupFromSearchHits(MarkupType: Integer; Const Hits: Array Of TPDFlibSearchHit): Integer;

參數

MarkupType1 = 醒目提示、2 = 底線、3 = 波浪線、4 = 刪除線
Hits要轉成註解的搜尋命中,通常由 SearchText、SearchTextEach、SearchTextBatch 或 GetTextInAreaEx 產生

傳回值

實際建立的註解數量。頁面超出範圍或矩形退化的命中會跳過、不計入。MarkupType 不在 1–4 之間、未選取文件或 Hits 為空時,傳回 0 且不改變目前的頁面選取

Remarks

要標記的命中是作用中 BeginTextSearch 階段已保留的那些時,請改用 HighlightTextSearchHits。搜尋前先設定 SearchContextChars,每個命中就能連周邊文字一起擷取,供標記前檢視或記錄

另見

AddTextMarkupAnnotation, HighlightTextSearchHits, SearchText, SearchTextEach, SearchTextBatch, TPDFlibSearchHit