TDocumentPage Class Reference

This object represents a single page from a document. More...

List of all members.

Public Member Functions
WideString	GetInksCode ()
	Returns the PostScript code generated from all the inks related to the page.
WideString	GetPatternID ()
	Retrieves the Pattern ID of the page.
	AsEPS (const WideString OutputFilename)
	Generates an EPS file of the page containing all the selected inks from all the pattern areas on the page.
Public Attributes
Integer	ID
	ID of the page.
Integer	Number
	0-based number of the page.
IPatternAreas	PatternAreas
	Collection of pattern areas on the page.
Single	Width
	Width of the page, in points.
Single	Height
	Height of the page, in points.
integer	Orientation
	Orientation of the page.
WordBool	HasInk
	Indicates whether a selected area on the page was inked or not.
Integer	InkedPatternAreaCount
	Returns the number of selected pattern areas named Name that have been marked by ink.
Integer	PatternAreaCount
	Returns the number of instances of selected pattern areas named Name.

---

Detailed Description

This object represents a single page from a document.

It may have any number of pattern areas on it, where pattern areas are visible portions of a single pattern. The page is physically stored in a PDF from the PDF Store.

---

Member Function Documentation

TDocumentPage::AsEPS

(

const WideString

OutputFilename

)

Generates an EPS file of the page containing all the selected inks from all the pattern areas on the page.

Parameters:

OutputFilename

Name of the file where to save the EPS.

WideString TDocumentPage::GetInksCode

(

)

Returns the PostScript code generated from all the inks related to the page.

The code is in pseudo EPS format: it is self-contained and is not a job in itself (e.g. it lacks any showpage command), but it does not follow the EPS format specification.

Returns:

The PostScript code.

Deprecated:

Use AsEPS instead, which returns a true EPS with better control on which inks gets emitted.

WideString TDocumentPage::GetPatternID

(

)

Retrieves the Pattern ID of the page.

The pattern ID is also known as the pattern's trace code.

Returns:

Pattern ID.

---

Member Data Documentation

WordBool TDocumentPage::HasInk

Indicates whether a selected area on the page was inked or not.

Single TDocumentPage::Height

Height of the page, in points.

Integer TDocumentPage::ID

ID of the page.

Integer TDocumentPage::InkedPatternAreaCount

Returns the number of selected pattern areas named Name that have been marked by ink.

Parameters:

Name	Name of the pattern area objects to count.

Integer TDocumentPage::Number

0-based number of the page.

integer TDocumentPage::Orientation

Orientation of the page.

This can be:

• 0 (portrait; no rotation)
• 1 (landscape; rotation of 90 degrees counter-clockwise)
• 2 (reverse portrait; rotation of 180 degrees)
• 3 (reverse landscape; rotation of 90 clockwise)

Integer TDocumentPage::PatternAreaCount

Returns the number of instances of selected pattern areas named Name.

Multiple pattern areas have the same name when a Capture Field in the document template is repeated.

Parameters:

Name	Name of the pattern area objects to count.

IPatternAreas TDocumentPage::PatternAreas

Collection of pattern areas on the page.

See also:

TPatternAreas

Single TDocumentPage::Width

Width of the page, in points.