You are here: Function Reference > Alphabetical Listing > T > TotalSheets

TotalSheets

Use this function to return the total number of sheets of paper that will print for a recipient. A sheet is considered a physical piece of paper that may have print on one or both sides. Therefore a duplex sheet with a front and back sections will count as one sheet.

Note Although the TotalSheets function does take duplex options into consideration, it has no knowledge of whether you will actually print to a printer that supports duplex commands. The count reflects what the document defines, not what the printer will support

Syntax

TotalSheets (Recipient)

Parameter

Description

Recipient

(Optional) If you include the Recipient parameter, the count only reflects the sheets that print for that recipient. If you omit the Recipient parameter, the count includes all recipients.

The count takes into consideration recipient copy counts and duplex options. A section may be empty (containing no text or discernible print objects) and still be designated to print. So, the count does not necessarily mean that the sheets will contain any real text.

Example

For example, assume you have a two-page document that is duplexed (prints front and back). Recipient1 gets one copy, while Recipient2 gets two copies.

With this command:

TotalSheets(Recipient1)

The system returns one (1) as the sheet count.

With this command:

TotalSheets(Recipient2)

The system returns two (2) as the sheet count, since the two-page document will be printed twice. if you omit the Recipient parameter, the system returns three (3) as the sheet count.

Note The count reflects when the function is called. The system cannot predict whether banner pages will be created or whether additional formatting or data entry will add or remove pages. Make sure you do not call this function until all page items have been created and formatted.

See also