AddPageHeaderFooter
Manipulación de páginas, Anotaciones
Descripción
Primitiva compartida detrás de AddPageHeader y AddPageFooter. Estampa una línea corrida en el borde superior o inferior de cada página del intervalo, usando la fuente seleccionada actualmente en modo de superposición, expandiendo los tokens de estampado para cada página de destino y encerrando el resultado en un artefacto de Pagination con subtipo Header o Footer
Sintaxis
Delphi
Function TPDFlib.AddPageHeaderFooter(Const PageRange, Text: WideString;
Margin, Opacity: Double; Alignment: Integer; IsHeader: Boolean): Integer;Parámetros
| PageRange | Expresión de intervalo de páginas, o una cadena vacía para todas las páginas |
|---|---|
| Text | Texto de la línea; los tokens que entiende ExpandStampTokens se expanden para cada página de destino |
| Margin | Distancia desde el borde superior (encabezado) o el borde inferior (pie) hasta la línea, en puntos PDF |
| Opacity | Opacidad del texto entre 0 y 1, donde 1 dibuja totalmente opaco |
| Alignment | 0 alinea a la izquierda en el margen, 1 centra entre los márgenes, 2 alinea a la derecha y mantiene la distancia del margen desde el borde derecho |
| IsHeader | True estampa un encabezado en el margen superior, False estampa un pie en el margen inferior |
Valores devueltos
El número de páginas en las que se estampó la línea, o 0 cuando no hay documento seleccionado, Text está vacío o no se pudo seleccionar ninguna página del intervalo
Comentarios
La línea se mide con la fuente y el tamaño actuales, así que llame primero a SelectFont. Con IsHeader a True la línea se sitúa a Margin del borde superior; con False se sitúa a Margin del borde inferior, calculado contra la altura de página y la altura de texto actuales. La página seleccionada se restaura cuando la llamada vuelve
Ejemplo
PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeaderFooter('2-', 'Confidential - <%PageNo%>', 20, 0.6, 2, False);