PageNumberingLabel Object

Description

Represents a page numbering label.

For a list of all members defined in this module, see PageNumberingLabel members.

Remarks

This class can be used to add page and section numbering to a PDF document. A document can be broken up into sections using the SetSectionStart method of the Document class. The following tokens can be used within the text of a PageNumberingLabel. They will be replaced with the appropriate value when the PDF is output.

Token Description
CP
Current page. The default numbering style is numeric. The current page can be offset using the is offset by the PageOffset property.

TP
Total pages. The default numbering style is numeric. The total pages can be offset using the is offset by the PageTotalOffset property.

SP
Section page. The default numbering style is the numbering style used by the section. The total pages can be offset using the is offset by the PageTotalOffset property.

ST Section Total. The default numbering style is the numbering style used by the section. The total pages can be offset using the is offset by the PageTotalOffset property.

ST Section Total. The default numbering style is the numbering style used by the section. The total pages can be offset using the is offset by the PageTotalOffset property.

PR Prefix. The sections prefix.

Token	Description
CP	Current page. The default numbering style is numeric. The current page can be offset using the is offset by the PageOffset property.
TP	Total pages. The default numbering style is numeric. The total pages can be offset using the is offset by the PageTotalOffset property.
SP	Section page. The default numbering style is the numbering style used by the section. The total pages can be offset using the is offset by the PageTotalOffset property.
ST	Section Total. The default numbering style is the numbering style used by the section. The total pages can be offset using the is offset by the PageTotalOffset property.
ST	Section Total. The default numbering style is the numbering style used by the section. The total pages can be offset using the is offset by the PageTotalOffset property.
PR	Prefix. The sections prefix.

All tokens except the !UNRECOGNISED ELEMENT TYPE 'PR'! token can also contain a numbering style specifier. The numbering style specifier is placed in parenthesis after the token. If no numbering style specifier is given, then the current sections numbering specifier is used. If there are no document sections or the current section does not have a numbering specifier, numeric numbering is used.

Numbering Style Numbering Style
1 Numeric. Arabic numbers are used: 1, 2, 3, etc. Example: "%%CP(1)%%"

i Lower Case Roman Numerals. Lower case roman numerals are used: i, ii, iii, etc. Example: "%%CP(i)%%".

I Upper Case Roman Numerals. Upper case roman numerals are used: I, II, III, etc. Example: "%%CP(I)%%".

a Lower Latin Letters. Lower case Latin letters are used: a, b, c, etc. After z, aa is used followed by bb, cc, ect. Example: "%%CP(a)%%".

A Upper Latin Letters. Upper case Latin letters are used: A, B, C, etc. After Z, AA is used followed by BB, CC, ect. Example: "%%CP(A)%%".

b Lower Latin Letters. Lower case Latin letters are used: a, b, c, etc. After z, aa is used followed by ab, ac, ect. Example: "%%CP(b)%%".

B Upper Latin Letters. Lower case Latin letters are used: A, B, C, etc. After Z, AA is used followed by AB, AC, ect. Example: "%%CP(B)%%".

Numbering Style	Numbering Style
1	Numeric. Arabic numbers are used: 1, 2, 3, etc. Example: "%%CP(1)%%"
i	Lower Case Roman Numerals. Lower case roman numerals are used: i, ii, iii, etc. Example: "%%CP(i)%%".
I	Upper Case Roman Numerals. Upper case roman numerals are used: I, II, III, etc. Example: "%%CP(I)%%".
a	Lower Latin Letters. Lower case Latin letters are used: a, b, c, etc. After z, aa is used followed by bb, cc, ect. Example: "%%CP(a)%%".
A	Upper Latin Letters. Upper case Latin letters are used: A, B, C, etc. After Z, AA is used followed by BB, CC, ect. Example: "%%CP(A)%%".
b	Lower Latin Letters. Lower case Latin letters are used: a, b, c, etc. After z, aa is used followed by ab, ac, ect. Example: "%%CP(b)%%".
B	Upper Latin Letters. Lower case Latin letters are used: A, B, C, etc. After Z, AA is used followed by AB, AC, ect. Example: "%%CP(B)%%".

There should be no spaces within a token, only the token and optional numbering style specifier. This token is invalid %%CP ( i )%% because of the extra spaces.

Here are some examples of valid tokens:

%%SP%%
%%SP(I)%%
%%PR%%
%%ST(B)%%

Interfaces

Implemented Interface	Description
Object

Example

[ASP - VBScript]