PlanetPress Capture Library
|
This object represents a single page from a document. More...
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 . |
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.
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.
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.
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.
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.
Returns the number of selected pattern areas named Name
that have been marked by ink.
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:
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.
Name | Name of the pattern area objects to count. |
IPatternAreas TDocumentPage::PatternAreas |
Collection of pattern areas on the page.
Single TDocumentPage::Width |
Width of the page, in points.