AddPageHeaderFooter
Манипуляции со страницами, Аннотации
Описание
Общая примитивная операция, лежащая в основе AddPageHeader и AddPageFooter. Штампует строку у верхнего или нижнего края каждой страницы диапазона, используя текущий выбранный шрифт в режиме наложения, разворачивая токены штампа для каждой целевой страницы и заключая результат в артефакт Pagination с подтипом Header или Footer
Синтаксис
Delphi
Function TPDFlib.AddPageHeaderFooter(Const PageRange, Text: WideString;
Margin, Opacity: Double; Alignment: Integer; IsHeader: Boolean): Integer;Параметры
| PageRange | Выражение диапазона страниц или пустая строка для всех страниц |
|---|---|
| Text | Текст строки; токены, понимаемые ExpandStampTokens, разворачиваются для каждой целевой страницы |
| Margin | Расстояние от верхнего края (верхний колонтитул) или нижнего края (нижний колонтитул) до строки в пунктах PDF |
| Opacity | Непрозрачность текста от 0 до 1, где 1 означает полностью непрозрачный вывод |
| Alignment | 0 выравнивает влево по полю, 1 центрирует между полями, 2 выравнивает вправо и сохраняет расстояние поля от правого края |
| IsHeader | True штампует верхний колонтитул у верхнего поля, False штампует нижний колонтитул у нижнего поля |
Возвращаемые значения
Количество страниц, на которых была проставлена строка, или 0, когда документ не выбран, Text пуст или ни одна страница диапазона не смогла быть выбрана
Примечания
Строка измеряется текущим шрифтом и размером, поэтому сначала вызовите SelectFont. При IsHeader True строка располагается на расстоянии Margin от верхнего края; при False — на расстоянии Margin от нижнего края, с учётом текущей высоты страницы и высоты текста. Выбранная страница восстанавливается при возврате из вызова
Пример
PDF.SelectFont(PDF.AddStandardFont(sfHelvetica));
PDF.AddPageHeaderFooter('2-', 'Confidential - <%PageNo%>', 20, 0.6, 2, False);