ApplyPageHeaderFooterSet

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

Descrição

Aplica um conjunto designado de cabeçalho e rodapé a um intervalo de páginas, com seleção pela primeira página e pela paridade física das páginas

Sintaxe

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

SetNameNome não sensível a maiúsculas e minúsculas anteriormente registado com SetPageHeaderFooterVariant
PageRangeExpressão de intervalo de páginas, ou uma cadeia vazia para todas as páginas

Valores devolvidos

Devolve o número de elementos não vazios de cabeçalho e rodapé desenhados, ou 0 quando o conjunto ou intervalo não tem conteúdo aplicável ou o âmbito atual da API não permite alterar páginas

Observações

Para cada função de cabeçalho e rodapé, a primeira página devolvida pelo intervalo utiliza first quando definido; as páginas seguintes utilizam odd ou even conforme o número físico da página e, na falta de variantes específicas, recorrem a default

Uma variante vazia definida explicitamente não desenha nada e impede a contingência, o que suporta primeiras páginas em branco

Cada modelo é expandido relativamente à página de destino antes da medição, e as variantes HTML utilizam a marcação expandida para o cálculo automático da altura

O conteúdo gerado é marcado como artefacto de paginação e a página, o tipo de letra, o estado do pintor e a definição de kerning selecionados pelo chamador são restaurados

Exemplo

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;