AddTextMarkupFromSearchHits

Annotations and hotspot links

Опис

Додає по одній анотації текстової розмітки на кожен прямокутник у Hits, перетворюючи будь-який масив збігів, повернутий SearchText, SearchTextEach, SearchTextBatch чи GetTextInAreaEx, просто на анотації розмітки без ручного циклу по 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

Return values

Кількість фактично створених анотацій. Збіги зі сторінкою поза діапазоном чи виродженим прямокутником пропускаються і не рахуються. Повертає 0 без зміни поточного вибору сторінки, коли MarkupType поза 1–4, не вибрано документ чи Hits порожній

Примітки

Використовуйте HighlightTextSearchHits натомість, коли розмітити треба збіги, які вже утримує активна сесія BeginTextSearch. Встановіть SearchContextChars перед пошуком, щоб також захопити навколишній текст для кожного збігу для огляду чи журналювання перед розміткою

Див. також

AddTextMarkupAnnotation, HighlightTextSearchHits, SearchText, SearchTextEach, SearchTextBatch, TPDFlibSearchHit