HighlightTextSearchHits

Annotations and hotspot links

Description

Tillämpar samma per-träff-markup-brygga som AddTextMarkupFromSearchHits, men hämtar sina träffar från den aktiva tillståndsbaserade söksession som startats med BeginTextSearch i stället för en anroparlämnad array

Returnerar 0 omedelbart, utan att lägga till någon annotering, när ingen söksession pågår, när sessionen byggdes mot ett annat dokument än det för tillfället valda, eller när sessionen behöll noll träffar

Syntax

Delphi

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

Parameters

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

Return values

Antalet markup-annoteringar skapade från den aktiva sessionens sparade träffar; 0 när ingen kvalificerad session finns

Remarks

Arbetar tillsammans med BeginTextSearch, NextTextSearchHit, TextSearchHitCount och EndTextSearch. Anropa detta innan EndTextSearch släpper de sparade träffarna. Använd AddTextMarkupFromSearchHits i stället när träffarna kommer från SearchText, SearchTextEach, SearchTextBatch eller GetTextInAreaEx i stället för en tillståndsbaserad session

See also

AddTextMarkupFromSearchHits, BeginTextSearch, NextTextSearchHit, TextSearchHitCount, EndTextSearch