AddSquareAnnotation

Annotations and hotspot links

Descrição

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.

Sintaxe

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;

Parâmetros

Left — Coordenada horizontal do canto inferior esquerdo do retângulo da anotação, nas unidades atuais

Top — Coordenada vertical do canto inferior esquerdo do retângulo da anotação, nas unidades atuais

Width — Largura do retângulo da anotação

Height — Altura do retângulo da anotação

BorderWidth — Largura do traço da borda do retângulo, nas unidades atuais. Gravado tanto no campo legado /Border quanto no dicionário de estilo de borda /BS

BorderRed, BorderGreen, BorderBlue — componentes RGB (0–1) da cor do traço, gravados em /C

Filled — 1 para emitir uma cor de preenchimento interior (/IC), 0 para deixar o retângulo sem preenchimento

FillRed, FillGreen, FillBlue — componentes RGB (0–1) da cor de preenchimento interior. Ignorado quando Filled é 0

Title — Nome do autor gravado na entrada /T da anotação. Passe uma string vazia para omitir

Contents — Corpo do popup associado à anotação. Passe uma string vazia para omitir

Transparency — Opacidade expressa como porcentagem transparente (0–100). A biblioteca converte isso para PDF /CA = 1 - Transparency/100 e limita ao intervalo

Valor de retorno

1 em caso de sucesso, 0 se nenhum documento estiver selecionado ou se a anotação não pôde ser criada

Remarks

A anotação é emitida com um conjunto padrão de campos de markup: /Type /Annot, /Subtype /Square, /Rect, /C, /IC (quando Filled), /BS, /Border, /CA, /F = 4 (imprimível), /M, /CreationDate, /NM, /T, /Contents, /Subj = "Rectangle" e /P. Isso corresponde ao que Adobe Acrobat e Foxit produzem em suas ferramentas de revisão de retângulos, de modo que fluxos de revisão externos possam localizar, editar, comentar e responder a anotação resultante

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