AddCaretAnnotation

Anotácie a hotspot odkazy

Opis

Pridáva anotáciu typu caret markup (PDF /Subtype /Caret) na vybranú stranu. Anotácia caret je vizuálny symbol, ktorý sa bežne používa na označenie miesta na strane, kde bol text alebo obsah vložený, vynechaný alebo inak vyžaduje pozornosť recenzenta. K dispozícii sú dva tvary symbolu: jednoduchý caret (None) alebo značka odseku (Paragraph). Zložky farby a priehľadnosť sa vyjadrujú v rozsahu 0–1; Transparency je daná v rozsahu 0–100 (0 = úplne nepriehľadné, 100 = úplne priehľadné). Knižnica zvýši verziu dokumentu na PDF 1.5, keď sa anotácia Caret vygeneruje pri nižšom uzamknutom minimálnom vydaní. Definované v ISO 32000-1 §12.5.6.11.

Syntax

Delphi

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

Parametre

Left — Vodorovná súradnica dolného ľavého rohu obdĺžnika anotácie, v aktuálnych jednotkách.

Top — Zvislá súradnica dolného ľavého rohu obdĺžnika anotácie, v aktuálnych jednotkách.

Width — Šírka obdĺžnika anotácie.

Height — Výška obdĺžnika anotácie.

SymbolType — Štýl symbolu Caret:

0 = None (jednoduchý caret "^")

1 = Paragraph (značka odseku "¶")

Akákoľvek iná hodnota sa považuje za 0 (None).

ColorRed, ColorGreen, ColorBlue — RGB zložky (0–1) farby caret, zapísané do /C.

Title — Meno autora zapísané do položky /T anotácie. Ak ho chcete vynechať, odovzdajte prázdny reťazec.

Contents — Telo vyskakovacieho okna priradeného k anotácii. Ak ho chcete vynechať, odovzdajte prázdny reťazec.

Transparency — Priehľadnosť vyjadrená ako percento priehľadnosti (0–100). Knižnica to prevádza na PDF /CA = 1 - Transparency/100 a orezáva do rozsahu.

Návratová hodnota

1 pri úspechu, 0 ak nie je vybraný dokument alebo sa anotáciu nepodarilo vytvoriť.

Poznámky

Anotácia sa zapíše s /Type /Annot, /Subtype /Caret, /Rect, /Sy (názov symbolu), /C, /CA, /F = 4 (tlačiteľná), /M, /CreationDate, /NM, /T, /Contents, /Subj = "Caret" a /P. Nepovinné pole /RD (posun caret v rámci /Rect) sa nezapisuje; čítače mu predvolene priradia samé nuly, takže caret zaberá celý obdĺžnik anotácie.

Na prepísanie obdĺžnika anotácie, farby alebo obsahu po vytvorení použite SetAnnotRect, SetAnnotBorderColor a SetAnnotContents.