TDocumentPages Class Reference

This object is a collection of all the pages from a single document. More...

List of all members.

Public Member Functions
Integer	Add (Integer PageNumber, Single Width, Single Height, Integer Orientation)
	Adds a new page in the document's page list.
Public Attributes
IDocumentPage	Item
	Returns the page at index ItemIndex.
IDocumentPage	ItemByID
	Returns the page whose ID is ItemID.
integer	Count
	Number of pages in the collection.

---

Detailed Description

This object is a collection of all the pages from a single document.

---

Member Function Documentation

Integer TDocumentPages::Add	(	Integer	PageNumber,
		Single	Width,
		Single	Height,
		Integer	Orientation
	)

Adds a new page in the document's page list.

Parameters:

PageNumber	0-based number of the page.
Width	Width of the page, in points.
Height	Height of the page, in points.
Orientation	Orientation of the page, where 0 is 0 degrees (portrait), 1 is 90 degrees counter-clockwise (landscape), 2 is 180 degrees (rotated portrait) or 3 is 90 degrees clockwise (rotated landscape).

Returns:

Item ID of the new entry.

---

Member Data Documentation

integer TDocumentPages::Count

Number of pages in the collection.

IDocumentPage TDocumentPages::Item

Returns the page at index ItemIndex.

Note:

The index of a page within a page collection can change over time. Do not rely on the index once the item has been retrieved; use its Item ID instead.

Parameters:

ItemIndex

Index of the DocumentPage object to retrieve.

See also:

TDocumentPage

IDocumentPage TDocumentPages::ItemByID

Returns the page whose ID is ItemID.

Parameters:

ItemID

ID of the DocumentPage object to retrieve.

See also:

TDocumentPage