SetPageHeaderFooterVariant

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

Descripción

Crea o sustituye una variante de un conjunto reutilizable con nombre de encabezados y pies de página continuos

Sintaxis

Delphi

Function TPDFlib.SetPageHeaderFooterVariant(Const SetName, VariantName,
  Text: WideString; Margin, Height, Opacity: Double; Alignment,
  IsHeader, RichText: Integer): Integer;

ActiveX

Function PDFlib::SetPageHeaderFooterVariant(SetName As String,
  VariantName As String, Text As String, Margin As Double,
  Height As Double, Opacity As Double, Alignment As Long,
  IsHeader As Long, RichText As Long) As Long

DLL

int DLSetPageHeaderFooterVariant(int InstanceID, const wchar_t* SetName,
  const wchar_t* VariantName, const wchar_t* Text, double Margin,
  double Height, double Opacity, int Alignment, int IsHeader, int RichText);
int DLSetPageHeaderFooterVariantA(int InstanceID, const char* SetName,
  const char* VariantName, const char* Text, double Margin,
  double Height, double Opacity, int Alignment, int IsHeader, int RichText);

Parámetros

SetName	Nombre que no distingue entre mayúsculas y minúsculas, compartido por las variantes que pertenecen a un conjunto de plantillas
VariantName	`default`, `first`, `odd` o `even`, comparado sin distinguir mayúsculas y minúsculas
Text	Plantilla de texto o HTML expandida por separado para cada página seleccionada; un valor vacío crea una variante en blanco explícita que impide recurrir al valor alternativo
Margin	Distancia no negativa desde el borde correspondiente de la página
Height	Altura del cuadro de contenido, o 0 para medir automáticamente la línea de texto sin formato o el contenido HTML
Opacity	Valor desde 0 para transparente hasta 1 para opaco
Alignment	0 para izquierda, 1 para centro o 2 para derecha
IsHeader	1 para un encabezado o 0 para un pie de página
RichText	1 para renderizar `Text` como HTML o 0 para utilizar la fuente y el estado del pintor seleccionados actualmente

Valores devueltos

Devuelve 1 cuando se almacenó la variante, o 0 cuando un nombre, variante, valor numérico, alineación o indicador no es válido

Observaciones

Una llamada posterior con el mismo nombre de conjunto, nombre de variante y función de encabezado o pie de página sustituye la definición existente

Las plantillas admiten los mismos campos de ampersand y <%name%> que AddPageHeader, incluidas las variables personalizadas resueltas por OnCalcVariable

Las definiciones pertenecen a la instancia de TPDFlib y se pueden aplicar a más de un documento

Ejemplo

PDF.SetPageHeaderFooterVariant('manual', 'first', '', 36, 0, 1, 0, 1, 0);
PDF.SetPageHeaderFooterVariant('manual', 'odd', 'Chapter — <%PageNo%>', 36, 0, 1, 2, 1, 0);
PDF.SetPageHeaderFooterVariant('manual', 'even', '<%PageNo%> — Chapter', 36, 0, 1, 0, 1, 0);