AddPageHeaderFooter

Manipulação de página, Anotações

Descrição

Primitivo compartilhado por AddPageHeader e AddPageFooter. Estampa uma linha contínua na borda superior ou inferior de cada página do intervalo, usando a fonte atualmente selecionada em modo de sobreposição, expandindo tokens de carimbo em relação a cada página de destino e envolvendo o resultado em um artefato de Paginação com subtipo Header ou Footer

Sintaxe

Delphi

Function TPDFlib.AddPageHeaderFooter(Const PageRange, Text: WideString;
  Margin, Opacity: Double; Alignment: Integer; IsHeader: Boolean): Integer;

Parâmetros

PageRangeExpressão de intervalo de páginas, ou uma string vazia para todas as páginas
TextTexto da linha; os tokens compreendidos por ExpandStampTokens expandem em relação a cada página de destino
MarginDistância da borda superior (cabeçalho) ou da borda inferior (rodapé) até a linha, em pontos PDF
OpacityOpacidade do texto entre 0 e 1, em que 1 desenha totalmente opaco
Alignment0 alinha à esquerda na margem, 1 centraliza entre as margens, 2 alinha à direita mantendo a distância da margem até a borda direita
IsHeaderTrue estampa um cabeçalho na margem superior, False estampa um rodapé na margem inferior

Valores de retorno

O número de páginas em que a linha foi estampada, ou 0 quando nenhum documento está selecionado, Text está vazio ou nenhuma página do intervalo pôde ser selecionada

Observações

A linha é medida com a fonte e o tamanho atuais, portanto chame SelectFont primeiro. Com IsHeader True, a linha fica a Margin da borda superior; com False, fica a Margin da borda inferior, calculada em relação à altura atual da página e à altura do texto. A página selecionada é restaurada quando a chamada retorna

Exemplo

PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeaderFooter('2-', 'Confidential - <%PageNo%>', 20, 0.6, 2, False);