PlanetPress Capture Library
|
This object represents a single document from the Document Store. More...
Public Member Functions | |
GeneratePdf (const WideString FileName) | |
Generates a new PDF file for the document by extracting the relevant pages from the original PDF and merging the captured inks on an optional layer. | |
Public Attributes | |
Integer | ID |
ID of the document. | |
TDocumentStatus | Status |
Status of the document. | |
WideString | OpenedDate |
Date at which the document was opened, in ISO 8601 format. | |
WideString | ClosedDate |
Date at which the document was closed, in ISO 8601 format. | |
WideString | Name |
Name of the document. | |
WideString | TemplateName |
Name of the PlanetPress document used to generate the document. | |
WideString | MetaData |
Metadata Document node of the document. | |
WideString | PatternSequence |
Pattern sequence of the document. | |
IDocumentPages | Pages |
Collection of pages in the document. | |
Integer | PdfID |
ID of the PDF file that holds the pages of the document. | |
Widestring | BatchName |
Pattern sequence of the document. | |
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 document from the Document Store.
The document is the central point of the pattern-enabled workflow and links all of the other pieces (pens, patterns, files, inks, etc.) together. It has a number of properties that are updated as it goes through the workflow.
TDocument::GeneratePdf | ( | const WideString | FileName | ) |
Generates a new PDF file for the document by extracting the relevant pages from the original PDF and merging the captured inks on an optional layer.
FileName | Complete path and file name where to save the document. |
Widestring TDocument::BatchName |
Pattern sequence of the document.
WideString TDocument::ClosedDate |
Date at which the document was closed, in ISO 8601 format.
Integer TDocument::ID |
ID of the document.
Integer TDocument::InkedPatternAreaCount |
Returns the number of selected pattern areas named Name
that have been marked by ink.
Name | Name of the pattern area objects to count. |
WideString TDocument::MetaData |
Metadata Document
node of the document.
WideString TDocument::Name |
Name of the document.
WideString TDocument::OpenedDate |
Date at which the document was opened, in ISO 8601 format.
IDocumentPages TDocument::Pages |
Collection of pages in the document.
Integer TDocument::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. |
WideString TDocument::PatternSequence |
Pattern sequence of the document.
Integer TDocument::PdfID |
ID of the PDF file that holds the pages of the document.
TDocumentStatus TDocument::Status |
Status of the document.
This is one of:
dsOpened
(0) - The document is opened dsClosedOptional
(1) - The document is closed because of an optional field. dsClosedMandatory
(2) - The document is closed because of a mandatory field. dsClosedFinal
(3) - The document is closed because of a final field.When read, the property returns the current status of the document.
When written to, the value cannot be dsOpened, the document is closed and all the patterns that were used by the document are released. A document that was closed cannot be reopened.
WideString TDocument::TemplateName |
Name of the PlanetPress document used to generate the document.