default_page_number: Default page number format

In formatters: ASCII Formatting for Values and Tables

Default page number format

Description

If set, the default page number string will appear on the bottom right of every page of a paginated table. The current cpp is used to position the string.

Usage

default_page_number()

set_default_page_number(page_number)

Arguments

page_number

(string) single string value to set the page number format. It should be formatted similarly to the following format: "page {i}/{n}". {i} will be replaced with the current page number, and {n} will be replaced with the total page number. Current cpp is used to position the string in the bottom right corner.

Value

The page number format string (NULL if not set).

Examples

default_page_number()
set_default_page_number("page {i} of {n}")
default_page_number()

formatters documentation built on Sept. 13, 2024, 1:10 a.m.