SetPageHeaderFooterVariant

Layout da página, Paginação, Texto HTML

Descrição

Cria ou substitui uma variante em um conjunto nomeado e reutilizável de cabeçalhos e rodapés corridos

Sintaxe

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	Case-insensitive name shared by variants that belong to one template set
VariantName	`default`, `first`, `odd`, or `even`, matched case-insensitively
Text	Template de texto ou HTML expandido separadamente para cada página selecionada; um valor vazio cria uma variante explicitamente em branco, que suprime o fallback
Margin	Distância não negativa da borda de página relevante
Height	Altura do content box, ou 0 para medir automaticamente a linha de texto simples ou o conteúdo HTML
Opacity	Valor de 0 (transparente) a 1 (opaco)
Alignment	0 for left, 1 for centre, or 2 for right
IsHeader	1 for a header or 0 for a footer
RichText	1 para renderizar `Text` como HTML, ou 0 para usar a fonte e o estado do painter selecionados no momento

Valores retornados

Retorna 1 quando o variant foi armazenado, ou 0 quando um nome, variant, valor numérico, alinhamento ou flag é inválido

Observações

Uma chamada posterior com o mesmo nome de conjunto, nome de variante e papel de header ou footer substitui a definição existente

Templates suportam os mesmos campos de e comercial e <%name%> de AddPageHeader, incluindo variáveis personalizadas resolvidas por OnCalcVariable. As definições pertencem à

instância TPDFlib e pode ser aplicado a mais de um documento

Exemplo

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);