ApplyPageHeaderFooterSet

Diseño de página, paginación, texto HTML

Descripción

Aplica un conjunto de encabezado y pie de página con nombre a un intervalo de páginas mediante selección de primera página y paridad de página física

Sintaxis

Delphi

Function TPDFlib.ApplyPageHeaderFooterSet(Const SetName,
  PageRange: WideString): Integer;

ActiveX

Function PDFlib::ApplyPageHeaderFooterSet(SetName As String,
  PageRange As String) As Long

DLL

int DLApplyPageHeaderFooterSet(int InstanceID, const wchar_t* SetName,
  const wchar_t* PageRange);
int DLApplyPageHeaderFooterSetA(int InstanceID, const char* SetName,
  const char* PageRange);

Parámetros

SetNameNombre sin distinción entre mayúsculas y minúsculas registrado previamente con SetPageHeaderFooterVariant
PageRangeExpresión de rango de páginas, o una cadena vacía para todas las páginas

Valores devueltos

Devuelve la cantidad de elementos no vacíos de encabezado y pie de página dibujados, o 0 cuando el conjunto o intervalo no tiene contenido aplicable o el ámbito actual de la API no puede cambiar páginas

Observaciones

Para cada rol de encabezado y pie de página, la primera página devuelta por el intervalo usa first cuando está definido; las páginas posteriores usan odd o even según su número físico de página, y las variantes específicas ausentes recurren a default

Una variante vacía definida explícitamente no dibuja nada e impide la reserva, lo que permite primeras páginas en blanco

Cada plantilla se expande respecto de su página de destino antes de la medición, y las variantes HTML usan el marcado expandido para calcular automáticamente la altura

El contenido generado se marca como un artefacto de paginación y se restauran la página seleccionada por quien llama, la fuente, el estado del pintor y la configuración de kerning

Ejemplo

PDF.SetPageHeaderFooterVariant('manual', 'default',
  '<b>Manual</b> — <%PageNo%>/<%TotalPages%>', 36, 0, 0.8, 2, 0, 1);
if PDF.ApplyPageHeaderFooterSet('manual', '3-20')= 0 then
  HandleLayoutError;