AddCaretAnnotation

Adnotacje i łącza obszarów aktywnych

Opis

Dodaje adnotację znacznikową karetki (PDF /Subtype /Caret) do wybranej strony. Adnotacja karetki jest symbolem wizualnym, który zwyczajowo oznacza miejsce na stronie, gdzie wstawiono lub pominięto tekst albo treść, bądź gdzie potrzebna jest uwaga recenzenta. Dostępne są dwa kształty symbolu: zwykła karetka (None) lub znak akapitu (Paragraph). Składowe koloru i krycie są wyrażane w skali 0–1; Transparency podaje się w skali 0–100 (0 = całkowicie nieprzezroczyste, 100 = całkowicie przezroczyste). Biblioteka podnosi wersję dokumentu do PDF 1.5, gdy adnotacja Caret jest emitowana przy niższej blokadzie wersji minimalnej. Definicję zawiera ISO 32000-1 §12.5.6.11

Składnia

Delphi

Function TPDFlib.AddCaretAnnotation(Left, Top, Width, Height: Double; SymbolType: Integer; ColorRed, ColorGreen, ColorBlue: Double; Const Title, Contents: WideString; Transparency: Integer): Integer;

Parametry

Left — współrzędna pozioma lewego dolnego narożnika prostokąta adnotacji ('prostokąt adnotacji') w bieżących jednostkach

Top — współrzędna pionowa lewego dolnego narożnika prostokąta adnotacji ('prostokąt adnotacji') w bieżących jednostkach

Width — szerokość prostokąta adnotacji

Height — wysokość prostokąta adnotacji

SymbolType — styl symbolu Caret:

0 = Brak (zwykły daszek "^")

1 = Akapit (znak akapitu "¶")

Każda inna wartość jest traktowana jako 0 (None)

ColorRed, ColorGreen, ColorBlue — składowe RGB (0–1) koloru karetki, zapisywane w /C

Title — Nazwa autora zapisywana we wpisie adnotacji oznaczonym jako '/T. Aby pominąć tę wartość, przekaż pusty ciąg

Contents — Treść wyskakującego okna powiązanego z adnotacją. Aby pominąć tę wartość, przekaż pusty ciąg

Transparency — Krycie wyrażone jako procent przezroczystości (0–100). Biblioteka przelicza tę wartość na PDF /CA = 1 - Transparency/100 i ogranicza ją do prawidłowego zakresu

Wartość zwracana

1 w przypadku powodzenia albo 0, gdy nie wybrano dokumentu lub nie można było utworzyć adnotacji

Uwagi

Adnotacja jest emitowana z polami /Type /Annot, /Subtype /Caret, /Rect, /Sy (nazwa symbolu), /C, /CA, /F = 4 (drukowalna), /M, /CreationDate, /NM, /T, /Contents, /Subj = "Caret" i /P. Opcjonalne pole /RD (przesunięcie karetki w /Rect) nie jest emitowane; czytniki domyślnie przyjmują dla niego same zera, dzięki czemu karetka zajmuje cały prostokąt adnotacji

Aby po utworzeniu zastąpić prostokąt adnotacji, kolor lub treść, użyj SetAnnotRect, SetAnnotBorderColor i SetAnnotContents