AddCaretAnnotation

Анотации и връзки към активни области

Описание

Добавя маркираща анотация Caret (PDF /Subtype /Caret) към избраната страница. Анотацията Caret е визуален символ, който по традиция отбелязва място на страницата, където текст или съдържание е вмъкнато, пропуснато или по друг начин изисква внимание от рецензент. Налични са две форми на символа: обикновен 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 — Стил на символа Caret:

0 = None (обикновен caret "^")

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

Всяка друга стойност се третира като 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 (printable), /M, /CreationDate, /NM, /T, /Contents, /Subj = "Caret" и /P. Полето /RD (отместване на caret вътре в /Rect) не се излъчва; четещите приложения по подразбиране го задават на нули, така че caret заема целия правоъгълник на анотацията

За да промените правоъгълника на анотацията, цвета или съдържанието след създаване, използвайте SetAnnotRect, SetAnnotBorderColor и SetAnnotContents