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