SetPageHeaderFooterVariant

Esquema de página, paginação, texto HTML

Descrição

Cria ou substitui uma variante num conjunto reutilizável com nome de cabeçalhos e rodapés correntes

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	Nome não sensível a maiúsculas e minúsculas partilhado pelas variantes que pertencem a um conjunto de modelos
VariantName	`default`, `first`, `odd` ou `even`, com correspondência sem distinção entre maiúsculas e minúsculas
Text	Modelo de texto ou HTML expandido separadamente para cada página selecionada; um valor vazio cria uma variante vazia explícita que suprime a alternativa
Margin	Distância não negativa a partir do limite relevante da página
Height	Altura da caixa de conteúdo, ou 0 para medir automaticamente a linha de texto simples ou o conteúdo HTML
Opacity	Valor entre 0 para transparente e 1 para opaco
Alignment	0 para a esquerda, 1 para o centro ou 2 para a direita
IsHeader	1 para um cabeçalho ou 0 para um rodapé
RichText	1 para compor `Text` como HTML ou 0 para utilizar o tipo de letra e o estado de pintura atualmente selecionados

Valores devolvidos

Devolve 1 quando a variante foi armazenada ou 0 quando um nome, variante, valor numérico, alinhamento ou sinalizador é inválido

Observações

Uma chamada posterior com o mesmo nome de conjunto, nome de variante e função de cabeçalho ou rodapé substitui a definição existente

Os modelos suportam os mesmos campos com E comercial e <%name%> que AddPageHeader, incluindo variáveis personalizadas resolvidas por OnCalcVariable

As definições pertencem à instância TPDFlib e podem ser aplicadas a mais do que 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);