AddPageHeader
Manipulación de páginas, Anotaciones y enlaces interactivos
Descripción
Estampa una línea de encabezado corrido en una o más páginas del documento seleccionado. El texto se dibuja en modo de superposición con la fuente seleccionada en ese momento, los tokens de estampa como <%PageNo%> se expanden según cada página destino antes de medir la línea, y la línea estampada queda encerrada en un artefacto de Pagination con subtipo Header, de modo que los lectores de PDF etiquetado lo traten como elemento fijo de la página y no como contenido repetido
Sintaxis
Delphi
Function TPDFlib.AddPageHeader(Const PageRange, Text: WideString;
Margin, Opacity: Double; Alignment: Integer): Integer;Parámetros
| PageRange | Expresión de rango de páginas, o una cadena vacía para todas las páginas |
|---|---|
| Text | Texto del encabezado; los tokens que entiende ExpandStampTokens se expanden según cada página destino |
| Margin | Distancia desde el borde superior de la página hasta la línea del encabezado, 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 conserva la distancia de margen desde el borde derecho |
Valores devueltos
El número de páginas en las que se estampó el encabezado, o 0 cuando no hay ningún documento seleccionado, Text está vacío o ninguna página del rango pudo seleccionarse
Comentarios
La línea se mide con la fuente y el tamaño actuales, así que llame primero a SelectFont; el contenido ya presente en la página sigue visible debajo de la superposición. La página seleccionada se restaura cuando la llamada regresa
Para los roles de encabezado de primera página, páginas impares y páginas pares con compatibilidad de contenido HTML, consulte ApplyPageHeaderFooterSet
Ejemplo
PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeader('', 'Quarterly report - page <%PageNo%> of <%TotalPages%>',
28, 1, 1);