textExpression (Text Expression)

A PXML string expression value to calculate a page number string.

In the Properties view, this property is the Text Expression property in the Text category.

Property of the PAGENOBOX, which expects a PXML string expression value to calculate a page number string. When set, the value of the property overrides all other formatting relevant properties of the PAGENOBOX, although the text property is still used to set the width.

Type: PXML.

If a value for this property, or for the X-Size or text properties, is not set, a default length is used in calculating the page number string from these functions:

These functions can be used to format and access specific page numbers and totals.

• Class String: format(Numeric number, Enum format) - formats the number as specified. The value for the format parameter can be ARABIC, LOWERROMAN or UPPERROMAN.
• Class Numeric: getPhysicalPageNumber() - gets the current page number of the physical page.
• Class Numeric: getTotalNumberOfPhysicalPages() - gets the total number of physical pages.
• Class Numeric: getPageNumber(String pageName)- gets the page number of the specified page
• Class Numeric: getTotalNumberOfPages(String pageName) - gets the total number of pages for the specified page.

See " Page N of M" examples.