AddPageNumberPlaceholder

Układ strony, Stronicowanie, Tekst

Opis

Rejestruje pole tekstowe na wybranej stronie i odracza jego rysowanie do chwili poznania ostatecznej liczby stron i rozdziałów

Składnia

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

Parametry

Left, Top, Width, HeightGeometria pola tekstowego w bieżącym układzie współrzędnych
TextSzablon zawierający tokeny paginacji i zwykły tekst
OptionsOpcja położenia pionowego i braku zawijania od 0 do 5, o takim samym znaczeniu jak w DrawTextBox

Tokens

<%PageNo%>Fizyczny numer wybranej strony
<%TotalPages%>Ostateczna liczba stron dokumentu
<%ChapterPageNo%>1-bazowy numer strony w bieżącym rozdziale
<%ChapterTotalPages%>Ostateczna liczba stron bieżącego rozdziału
<%ChapterName%>Nazwa zarejestrowana przez StartPageNumberChapter

Wartości zwracane

Zwraca 1-bazowy identyfikator symbolu zastępczego albo 0 w przypadku nieprawidłowej geometrii, opcji, tekstu, wyboru lub dokumentu, którego symbole zastępcze zostały już rozwiązane

Uwagi

Wywołanie przechwytuje wybraną czcionkę, rozmiar tekstu, kolory, wyrównanie, odstępy, kerning, dekorację, skalę, początek układu i przetłumaczoną geometrię pola tekstowego bez rysowania zawartości strony

Tokeny daty, czasu i niestandardowego OnCalcVariable używają tych samych reguł co ExpandVariableTokens

Wywołaj ResolvePageNumberPlaceholders dokładnie raz po ustabilizowaniu pełnej struktury stron i przed zapisem