AddPageHeaderFooter
Manipulação de páginas, anotações
Descrição
Primitivo partilhado por AddPageHeader e AddPageFooter. Estampa uma linha contínua no limite superior ou inferior de cada página do intervalo, usando a fonte atualmente selecionada em modo de sobreposição, expandindo tokens de estampa face a cada página de destino e encerrando o resultado num artefacto Pagination com o subtipo Header ou Footer
Sintaxe
Delphi
Function TPDFlib.AddPageHeaderFooter(Const PageRange, Text: WideString;
Margin, Opacity: Double; Alignment: Integer; IsHeader: Boolean): Integer;Parâmetros
| PageRange | Expressão de intervalo de páginas, ou uma cadeia vazia para todas as páginas |
|---|---|
| Text | Texto da linha; os tokens compreendidos por ExpandStampTokens expandem face a cada página de destino |
| Margin | Distância do limite superior (cabeçalho) ou do limite inferior (rodapé) à linha, em pontos PDF |
| Opacity | Opacidade do texto entre 0 e 1, em que 1 desenha totalmente opaco |
| Alignment | 0 alinha à esquerda na margem, 1 centra entre as margens, 2 alinha à direita mantendo a distância da margem ao limite direito |
| IsHeader | True 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 correntes, pelo que chame primeiro SelectFont. Com IsHeader a True, a linha fica a Margin do limite superior; com False, fica a Margin do limite inferior, calculado face à altura da página corrente e à altura do texto. A página selecionada é restaurada quando a chamada devolve
Exemplo
PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeaderFooter('2-', 'Confidential - <%PageNo%>', 20, 0.6, 2, False);