SetPageHeaderFooterVariant

Disposition des pages, pagination, texte HTML

Description

Crée ou remplace une variante dans un ensemble nommé réutilisable d'en-têtes et de pieds de page continus

Syntaxe

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

Paramètres

SetName	Nom insensible à la casse partagé par les variantes appartenant à un même ensemble de modèles
VariantName	`default`, `first`, `odd` ou `even`, comparé sans tenir compte de la casse
Text	Modèle texte ou HTML développé séparément pour chaque page sélectionnée ; une valeur vide crée une variante blanche explicite qui supprime le repli
Margin	Distance non négative à partir du bord de page concerné
Height	Hauteur de la zone de contenu, ou 0 pour mesurer automatiquement la ligne de texte brut ou le contenu HTML
Opacity	Valeur de 0 pour transparent à 1 pour opaque
Alignment	0 pour gauche, 1 pour centre ou 2 pour droite
IsHeader	1 pour un en-tête ou 0 pour un pied de page
RichText	1 pour rendre `Text` en HTML, ou 0 pour utiliser la police et l'état du moteur de tracé actuellement sélectionnés

Valeurs de retour

Renvoie 1 si la variante a été stockée, ou 0 si un nom, une variante, une valeur numérique, un alignement ou un indicateur n'est pas valide

Remarques

Un appel ultérieur avec les mêmes noms d'ensemble et de variante ainsi que le même rôle d'en-tête ou de pied de page remplace la définition existante

Les modèles acceptent les mêmes champs esperluette et <%name%> que AddPageHeader, y compris les variables personnalisées résolues par OnCalcVariable

Les définitions appartiennent à l'instance TPDFlib et peuvent être appliquées à plusieurs documents

Exemple

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