HighlightTextSearchHits

Annotations and hotspot links

Description

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

Vráti 0 okamžite, bez pridania akejkoľvek anotácie, keď sa nebeží žiadna vyhľadávacia session, keď session bola postavená na inom dokumente než ten práve vybraný, alebo keď session uchovala nulový počet zásahov

Syntax

Delphi

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

Parameters

MarkupType1 = Highlight, 2 = Underline, 3 = Squiggly, 4 = StrikeOut

Return values

Počet markup anotácií vytvorených z uchovaných zásahov aktívnej session; 0, keď neexistuje žiadna vhodná session

Remarks

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

See also

AddTextMarkupFromSearchHits, BeginTextSearch, NextTextSearchHit, TextSearchHitCount, EndTextSearch