AddPageHeader

Manipulación de páginas, Anotaciones

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 actualmente, los tokens de estampado como <%PageNo%> se expanden para cada página de 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 la traten como moblaje de página y no como contenido repetido

Sintaxis

Delphi

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

Parámetros

PageRangeExpresión de intervalo de páginas, o una cadena vacía para todas las páginas
TextTexto del encabezado; los tokens que entiende ExpandStampTokens se expanden para cada página de destino
MarginDistancia desde el borde superior de la página hasta la línea del encabezado, en puntos PDF
OpacityOpacidad del texto entre 0 y 1, donde 1 dibuja totalmente opaco
Alignment0 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

Valores devueltos

El número de páginas en las que se estampó el encabezado, 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; el contenido ya presente en la página sigue visible debajo de la superposición. La página seleccionada se restaura cuando la llamada vuelve

Para los roles de encabezado de primera página, de páginas impares y de páginas pares con soporte de contenido HTML, véase ApplyPageHeaderFooterSet

Ejemplo

PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeader('', 'Quarterly report - page <%PageNo%> of <%TotalPages%>',
  28, 1, 1);