SetPageHeaderFooterVariant

Układ strony, Stronicowanie, Tekst HTML

Opis

Tworzy lub zastępuje wariant w nazwanym zestawie nagłówków bieżących i stopek wielokrotnego użytku

Składnia

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

Parametry

SetName	Nazwa zestawu wspólna dla wariantów, bez uwzględniania wielkości liter
VariantName	`default`, `first`, `odd` lub `even`, bez uwzględniania wielkości liter
Text	Szablon tekstowy lub HTML rozwijany osobno dla każdej strony; pusta wartość tworzy jawnie pusty wariant wyłączający dziedziczenie
Margin	Nieujemna odległość od odpowiedniej krawędzi strony
Height	Wysokość pola zawartości albo 0 dla automatycznego pomiaru
Opacity	Od 0 dla przezroczystego do 1 dla nieprzezroczystego
Alignment	0 do lewej, 1 do środka, 2 do prawej
IsHeader	1 dla nagłówka, 0 dla stopki
RichText	1 renderuje `Text` jako HTML, 0 używa bieżącego fontu i stanu rysowania

Wartości zwracane

Zwraca 1 po zapisaniu wariantu albo 0, gdy nazwa, wariant, wartość liczbowa, wyrównanie lub flaga są nieprawidłowe

Uwagi

Późniejsze wywołanie z tą samą nazwą zestawu, wariantu i rolą nagłówka lub stopki zastępuje istniejącą definicję

Szablony obsługują te same pola ampersand i <%name%> co AddPageHeader, w tym zmienne niestandardowe rozwiązywane przez OnCalcVariable

Definicje należą do instancji TPDFlib i mogą być stosowane do wielu dokumentów

Przykład

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