PlanetPress Capture Library
|
This object represents an area on the page where a pattern is visible. More...
Public Member Functions | |
AsEPS (const WideString OutputFilename) | |
Generates an EPS file of pattern area containing all the selected inks. | |
Public Attributes | |
Integer | ID |
ID of the pattern area. | |
Single | Left |
Distance from the left edge of the page, in points. | |
Single | Top |
Distance from the top of the page, in points. | |
Single | Width |
Horizontal width of the area, in points. | |
Single | Height |
Vertical height of the area, in points. | |
TPatternAreaType | AreaType |
Type of the field. | |
Integer | GroupIndex |
Group index of the area for use when the area is of type ptMandatory . | |
Integer | WriteCount |
Number of times this area was written to. | |
WordBool | AllowRewrite |
Whether or not the area can be written to more than once. | |
WideString | Name |
Name of the pattern area as specified by the document designer. | |
TMaskType | MaskType |
Mask type for a multi-area field. | |
WideString | MaskName |
Name of the multi-area field mask as specified by the document designer. | |
WideString | MaskFormat |
Format of the multi-area field mask as sepecified by the document designer. | |
Integer | Rows |
Number of rows. Only used for multi-area fields. | |
Integer | Columns |
Number of columns. Only used for multi-area field. | |
WideString | MultiAreaColor |
Color of the line separating each area in a multi-area field. | |
IInks | Inks |
Collection of inks found in the pattern area. | |
IICRDatas | ICRDatas |
Collection of ICRData returned by an ICR engine representing the content of the area based on the available inks. | |
TPatternAreaStyle | AreaStyle |
Style of the pattern area. | |
Integer | SampleCount |
Number of samples recorded by the pen for the whole area. |
This object represents an area on the page where a pattern is visible.
A pattern area is used to capture the user's writing. Pidgets, i.e. special pieces of pattern that are used for special purposes such as changing the ink color, are not recorded in the database.
The pattern area is a rectangular region positioned from the top-left corner of the page. It cannot be rotated; the width and height properties are always horizontal and vertical respectively.
TPatternArea::AsEPS | ( | const WideString | OutputFilename | ) |
Generates an EPS file of pattern area containing all the selected inks.
OutputFilename | Name of the file where to save the EPS. |
WordBool TPatternArea::AllowRewrite |
Whether or not the area can be written to more than once.
TPatternAreaStyle TPatternArea::AreaStyle |
Style of the pattern area.
This can be one of:
psCheckBox
(0) psListBox
(1) psTextBox
(2) psMultiArea
(3) TPatternAreaType TPatternArea::AreaType |
Type of the field.
It can be one of:
ptMandatory
(0), ptOptional
(1) ptFinal
(2).Fields of type ptMandatory can be grouped together to be mutually exclusive by assigning them the same higher-than-zero group index.
Integer TPatternArea::Columns |
Number of columns. Only used for multi-area field.
Integer TPatternArea::GroupIndex |
Group index of the area for use when the area is of type ptMandatory
.
Single TPatternArea::Height |
Vertical height of the area, in points.
IICRDatas TPatternArea::ICRDatas |
Collection of ICRData returned by an ICR engine representing the content of the area based on the available inks.
Integer TPatternArea::ID |
ID of the pattern area.
IInks TPatternArea::Inks |
Collection of inks found in the pattern area.
Single TPatternArea::Left |
Distance from the left edge of the page, in points.
WideString TPatternArea::MaskFormat |
Format of the multi-area field mask as sepecified by the document designer.
WideString TPatternArea::MaskName |
Name of the multi-area field mask as specified by the document designer.
TMaskType TPatternArea::MaskType |
Mask type for a multi-area field.
It can be one of:
mtNone
(0) mtNumeric
(1) mtAlphabetic
(2) mtAlphanumeric
(3) mtCustom
(4) mtRegExp
(5) WideString TPatternArea::MultiAreaColor |
Color of the line separating each area in a multi-area field.
The format of the string is a PressTalk language-compliant color array.
WideString TPatternArea::Name |
Name of the pattern area as specified by the document designer.
This maps to the PressTalk name defined in the PlanetPress template that was used to create the document.
Integer TPatternArea::Rows |
Number of rows. Only used for multi-area fields.
Integer TPatternArea::SampleCount |
Number of samples recorded by the pen for the whole area.
Single TPatternArea::Top |
Distance from the top of the page, in points.
Single TPatternArea::Width |
Horizontal width of the area, in points.
Integer TPatternArea::WriteCount |
Number of times this area was written to.