AddCaretAnnotation

Анотації та активні зони-посилання

Опис

Додає анотацію розмітки каретки (PDF /Subtype /Caret) до вибраної сторінки. Анотація-каретка — це візуальний символ, який за звичаєм позначає позицію на сторінці, де вставлено, пропущено текст чи вміст, що потребує уваги рецензента. Доступні дві форми символу: проста каретка (None) чи знак абзацу (Paragraph). Колірні компоненти та непрозорість виражаються за шкалою 0–1; Transparency задається за шкалою 0–100 (0 = повністю непрозоро, 100 = повністю прозоро). Бібліотека підвищує версію документа до PDF 1.5, коли анотація Caret виводиться за нижчого замка мінімальної версії. Визначено в ISO 32000-1 §12.5.6.11

Синтаксис

Delphi

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

Параметри

Left — горизонтальна координата лівого нижнього кута прямокутника анотації в поточних одиницях

Top — вертикальна координата лівого нижнього кута прямокутника анотації в поточних одиницях

Width — ширина прямокутника анотації

Height — висота прямокутника анотації

SymbolType — стиль символу каретки:

0 = нічого (проста каретка "^")

1 = абзац (знак абзацу "¶")

Будь-яке інше значення трактується як 0 (None)

ColorRed, ColorGreen, ColorBlue — компоненти RGB (0–1) кольору знака вставки (caret), що записуються в /C

Title — ім'я автора, яке записується в запис /T анотації. Щоб пропустити, передайте порожній рядок

Contents — вміст спливного вікна, пов'язаного з анотацією. Щоб пропустити, передайте порожній рядок

Transparency — прозорість у відсотках (0–100). Бібліотека перераховує це в PDF /CA = 1 - Transparency/100 і обрізає значення до допустимого діапазону

Значення, що повертається

1 в разі успіху, 0 — якщо не вибрано жодного документа або анотацію не вдалося створити

Примітки

Анотація емітується з /Type /Annot, /Subtype /Caret, /Rect, /Sy (назва символу), /C, /CA, /F = 4 (придатна до друку), /M, /CreationDate, /NM, /T, /Contents, /Subj = "Caret" і /P. Необов'язкове поле /RD (зсув знака вставки в межах /Rect) не емітується; читачі типово вважають його нульовим, тож знак вставки займає весь прямокутник анотації

Щоб змінити прямокутник, колір або вміст анотації після створення, використовуйте SetAnnotRect, SetAnnotBorderColor і SetAnnotContents.