AddCaretAnnotation

Anotações e ligações de áreas interativas

Descrição

Adiciona uma anotação de marca de cursor (PDF /Subtype /Caret) à página selecionada. Uma anotação Caret é um símbolo visual que, por convenção, assinala uma posição na página onde foi inserido ou omitido texto ou conteúdo, ou que requer a atenção do revisor por outro motivo. Estão disponíveis duas formas de símbolo: um cursor simples (None) ou uma marca de parágrafo (Paragraph). Os componentes de cor e a opacidade são expressos numa escala de 0–1; Transparency é indicada numa escala de 0–100 (0 = totalmente opaco, 100 = totalmente transparente). A biblioteca eleva a versão do documento para PDF 1.5 quando uma anotação Caret é emitida sob um bloqueio de versão mínima inferior. Definido na norma ISO 32000-1 §12.5.6.11

Sintaxe

Delphi

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

Parâmetros

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

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

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

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

SymbolType — estilo do símbolo Caret:

0 = Nenhum (sinal de inserção simples "^")

1 = Parágrafo (sinal de parágrafo "¶")

Qualquer outro valor é tratado como 0 (None)

ColorRed, ColorGreen, ColorBlue — Componentes RGB (0–1) da cor do cursor, escritos em /C

Título — Nome do autor escrito na entrada /T da anotação's. Passe uma cadeia vazia para ignorar

Contents — corpo do pop-up associado à anotação. Passe uma cadeia vazia para omitir

Transparency — opacidade expressa como percentagem de transparência (0–100). A biblioteca converte-a em PDF /CA = 1 - Transparency/100 e limita-a ao intervalo

Valor devolvido

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

Observações

A anotação é emitida com /Type /Annot, /Subtype /Caret, /Rect, /Sy (o nome do símbolo), /C, /CA, /F = 4 (imprimível), /M, /CreationDate, /NM, /T, /Contents, /Subj = "Caret" e /P. O campo /RD opcional (deslocamento do cursor dentro de /Rect) não é emitido; por predefinição, os leitores atribuem-lhe apenas zeros, pelo que o cursor ocupa todo o retângulo da anotação

Para substituir o retângulo, a cor ou o conteúdo da anotação após a criação, utilize SetAnnotRect, SetAnnotBorderColor e SetAnnotContents