SetPageHeaderFooterVariant

Макет страницы, разбивка на страницы, HTML-текст

Описание

Создает или заменяет один вариант в именованном переиспользуемом наборе колонтитулов

Синтаксис

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

Параметры

SetName	Case-insensitive name shared by variants that belong to one template set
VariantName	`default`, `first`, `odd`, or `even`, matched case-insensitively
Text	Текстовый или HTML-шаблон, раскрываемый отдельно для каждой выбранной страницы; пустое значение создает явный пустой вариант, подавляющий откат
Margin	Неотрицательное расстояние от соответствующего края страницы
Height	Высота блока содержимого либо 0 для автоматического измерения строки простого текста или HTML-содержимого
Opacity	Значение от 0 (прозрачно) до 1 (непрозрачно)
Alignment	0 for left, 1 for centre, or 2 for right
IsHeader	1 for a header or 0 for a footer
RichText	1 рендерит `Text` как HTML, 0 использует текущий выбранный шрифт и состояние рисователя

Возвращаемые значения

Возвращает 1 при сохранённом варианте, 0 — при недопустимых имени, варианте, числовом значении, выравнивании или флаге

Примечания

Повторный вызов с тем же именем набора, именем варианта и ролью колонтитула заменяет существующее определение

Шаблоны поддерживают те же поля амперсанда и <%name%>, что и AddPageHeader, включая пользовательские переменные, разрешаемые OnCalcVariableОпределения принадлежат

TPDFlib экземпляр и может применяться к нескольким документам

Пример

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