HighlightTextSearchHits

Annotations and hotspot links

Описание

Applies the same per-hit markup bridge as AddTextMarkupFromSearchHits, but sources its hits from the active stateful search session started with BeginTextSearch instead of a caller-supplied array

Сразу возвращает 0, не добавляя аннотаций, если сессия поиска не запущена, построена по другому документу, а не выбранному сейчас, или удерживает ноль попаданий

Синтаксис

Delphi

Function TPDFlib.HighlightTextSearchHits(MarkupType: Integer): Integer;

Параметры

Return values

Число созданных разметочных аннотаций из удерживаемых попаданий активной сессии; 0, если подходящей сессии нет

Примечания

Works together with BeginTextSearch, NextTextSearchHit, TextSearchHitCount and EndTextSearch. Call this before EndTextSearch releases the retained hits. Use AddTextMarkupFromSearchHits instead when the hits come from SearchText, SearchTextEach, SearchTextBatch or GetTextInAreaEx rather than a stateful session

См. также

AddTextMarkupFromSearchHits, BeginTextSearch, NextTextSearchHit, TextSearchHitCount, EndTextSearch