AddSquareAnnotation

Annotations and hotspot links

Описание

Adds a rectangular markup annotation (PDF /Subtype /Square) to the selected page. The annotation draws a stroked rectangle inscribed in the given bounding rectangle and can optionally be filled with a solid interior color. Color components and opacity are expressed on a 0–1 scale; Transparency is given on a 0–100 scale (0 = fully opaque, 100 = fully transparent). Because this entry point emits the PDF 1.4 annotation /CA opacity key, the library raises lower unlocked documents to PDF 1.4 before saving; locked lower targets are rejected by the compatibility gate. Defined in ISO 32000-1 §12.5.6.8.

Синтаксис

Delphi

Function TPDFlib.AddSquareAnnotation(Left, Top, Width, Height: Double; BorderWidth: Double; BorderRed, BorderGreen, BorderBlue: Double; Filled: Integer; FillRed, FillGreen, FillBlue: Double; Const Title, Contents: WideString; Transparency: Integer): Integer;

Параметры

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

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

Width — ширина прямоугольника аннотации

Height — высота прямоугольника аннотации

BorderWidth — толщина обводки рамки прямоугольника в текущих единицах; записывается и в унаследованное поле /Border, и в словарь стиля рамки /BS

BorderRed, BorderGreen, BorderBlue — RGB-составляющие (0–1) цвета обводки, записываемые в /C

Filled — 1 добавляет цвет заливки внутренней области (/IC), 0 оставляет прямоугольник незалитым

FillRed, FillGreen, FillBlue — RGB-составляющие (0–1) цвета заливки внутренней области; игнорируются при Filled = 0

Title — имя автора, записываемое в запись /T аннотации; пустая строка пропускает параметр

Contents — текст всплывающей подсказки, связанной с аннотацией; пустая строка пропускает параметр

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

Возвращаемое значение

1 в случае успеха, 0 — если документ не выбран или аннотацию не удалось создать

Примечания

Аннотация выдаётся со стандартным разметочным набором: /Type /Annot, /Subtype /Square, /Rect, /C, /IC (при Filled), /BS, /Border, /CA, /F = 4 (печатаемая), /M, /CreationDate, /NM, /T, /Contents, /Subj = "Rectangle", /P. Так делают инструменты рецензирования прямоугольников Adobe Acrobat и Foxit, поэтому внешние процессы рецензирования смогут находить, править, комментировать полученную аннотацию и отвечать на неё

To overwrite the annotation rectangle, color, contents, or border after creation, use SetAnnotRect, SetAnnotBorderColor, SetAnnotContents, and SetAnnotBorderStyle.