AddTextMarkupFromSearchHits

注釈とホットスポットリンク

説明

Hits 内の各矩形に 1 つのテキストマークアップ注釈を追加する。SearchTextSearchTextEachSearchTextBatchGetTextInAreaEx が返す任意のヒット配列を、AddTextMarkupAnnotation に対する手動ループなしで直接マークアップ注釈に変換する

各ヒットで、Page が文書ページ範囲外、または Right/BottomLeft/Top を超えない矩形はスキップされます。残った矩形では注釈追加前にヒットのページを一時選択し、複数ページのヒットでも開始時の選択ページを必ず復元します

構文

Delphi

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

パラメータ

MarkupType1 = Highlight、2 = Underline、3 = Squiggly、4 = StrikeOut
Hits注釈に変換する検索ヒットです。通常は SearchTextSearchTextEachSearchTextBatchGetTextInAreaEx によって生成されます

戻り値

実際に作成された注釈数。ページが範囲外のヒットや退化した矩形はスキップされ、数には含まれません。MarkupType が 1–4 の範囲外、文書が選択されていない、または Hits が空の場合は、現在のページ選択を変更せず 0 を返します

備考

HighlightTextSearchHits は、マークアップ対象のヒットがアクティブな BeginTextSearch セッションにより既に保持されている場合に使用します 検索前に SearchContextChars を設定すると、マークアップ前の確認またはログ記録のため、各ヒットの周囲のテキストも取得します

関連項目

AddTextMarkupAnnotationHighlightTextSearchHitsSearchTextSearchTextEachSearchTextBatchTPDFlibSearchHit