AddPageNumberPlaceholder

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

Описание

Записывает текстовый блок на выбранной странице и откладывает его отрисовку до получения итоговых чисел страниц и глав

Синтаксис

Delphi

Function TPDFlib.AddPageNumberPlaceholder(Left, Top, Width, Height: Double; Const Text: WideString; Options: Integer): Integer;

ActiveX

Function PDFlib::AddPageNumberPlaceholder(Left As Double, Top As Double, Width As Double, Height As Double, Text As String, Options As Long) As Long

DLL

int DLAddPageNumberPlaceholder(int InstanceID, double Left, double Top, double Width, double Height, const wchar_t* Text, int Options);
int DLAddPageNumberPlaceholderA(int InstanceID, double Left, double Top, double Width, double Height, const char* Text, int Options);

Параметры

Left, Top, Width, Height	Геометрия текстового блока в текущей системе координат
Text	Шаблон с токенами пагинации и обычным текстом
Options	Вертикальное размещение и опция отказа от переноса от 0 до 5 с тем же смыслом, что в `DrawTextBox`

Tokens

`<%PageNo%>`	Physical selected page number
`<%TotalPages%>`	Final document page count
`<%ChapterPageNo%>`	Номер страницы в текущей главе, начиная с 1
`<%ChapterTotalPages%>`	Итоговое число страниц текущей главы
`<%ChapterName%>`	Name registered by `StartPageNumberChapter`

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

Возвращает идентификатор плейсхолдера, начиная с 1, либо 0 при недопустимых геометрии, опциях, тексте, выделении либо документе с уже разрешёнными плейсхолдерами

Примечания

Вызов фиксирует выбранные шрифт, размер текста, цвета, выравнивание, интервалы, кернинг, оформление, масштаб, начало координат и преобразованную геометрию текстового блока, не рисуя содержимое страницы

Токены даты, времени и пользовательский OnCalcVariable следуют правилам ExpandVariableTokensВызов

ResolvePageNumberPlaceholders ровно один раз после стабилизации полной структуры страниц и перед сохранением