ApplyPageHeaderFooterSet

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

Descrição

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

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, sem diferenciar maiúsculas, registrado anteriormente com SetPageHeaderFooterVariant
PageRangeExpressão de intervalo de páginas, ou uma string vazia para todas as páginas

Valores retornados

Retorna o número de elementos de cabeçalho e rodapé não vazios desenhados, ou 0 quando o conjunto ou o intervalo não tem conteúdo aplicável ou o escopo atual da API não pode trocar de página

Observações

Para cada papel de cabeçalho e rodapé, a primeira página devolvida pelo intervalo usa first quando definido; as páginas seguintes usam odd ou even conforme o número físico da página delas, e variantes específicas ausentes caem no default. Uma variante explicitamente definida como vazia não desenha nada e impede o fallback, o que permite primeiras páginas em branco

Cada template é expandido contra sua página de destino antes da medição, e as variantes HTML usam a marcação expandida para o cálculo automático de altura

Todo modelo é expandido contra sua página de destino antes da medição, e as variantes HTML usam a marcação expandida para o cálculo automático de altura

O conteúdo gerado é marcado como artifact de paginação e a página selecionada, a fonte, o estado do painter e a configuração de kerning do 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;