AddTextMarkupFromSearchHits

Anmerkungen und Hotspot-Links

Beschreibung

Fügt für jedes Rechteck in Hits eine Textmarkierungsannotation hinzu und wandelt damit jedes von SearchText, SearchTextEach, SearchTextBatch oder GetTextInAreaEx zurückgegebene Trefferarray direkt in Markierungsannotationen um, ohne eine manuelle Schleife über AddTextMarkupAnnotation

Für jeden Treffer wird ein Rechteck übersprungen, dessen Page außerhalb des Seitenbereichs des Dokuments liegt oder dessen Right/Bottom Left/Top nicht überschreitet. Jedes verbleibende Rechteck wählt vor dem Hinzufügen der Anmerkung vorübergehend die Trefferseite aus; die beim Aufrufbeginn ausgewählte Seite wird vor der Rückkehr stets wiederhergestellt, auch bei Treffern über mehrere Seiten

Syntax

Delphi

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

Parameter

MarkupType1 = Hervorheben, 2 = Unterstreichen, 3 = Wellenlinie, 4 = Durchstreichen
HitsSuchtreffer, die in Anmerkungen umgewandelt werden sollen und typischerweise von SearchText, SearchTextEach, SearchTextBatch oder GetTextInAreaEx erzeugt wurden

Rückgabewerte

Die Anzahl der tatsächlich erstellten Anmerkungen. Treffer mit einer außerhalb des Bereichs liegenden Seite oder einem entarteten Rechteck werden übersprungen und nicht gezählt. Gibt 0 zurück, ohne die aktuelle Seitenauswahl zu ändern, wenn MarkupType außerhalb von 1–4 liegt, kein Dokument ausgewählt oder Hits leer ist

Anmerkungen

Verwenden Sie stattdessen HighlightTextSearchHits, wenn die zu markierenden Treffer bereits von einer aktiven Sitzung mit BeginTextSearch beibehalten werden. Legen Sie vor der Suche SearchContextChars fest, um zusätzlich den umgebenden Text jedes Treffers zur Prüfung oder Protokollierung vor der Markierung zu erfassen

Siehe auch

AddTextMarkupAnnotation, HighlightTextSearchHits, SearchText, SearchTextEach, SearchTextBatch, TPDFlibSearchHit