This object is a collection of all the inks found in a pattern area.
More...
List of all members.
Public Member Functions |
Integer | Add (Integer PgcID, const WideString StartTime, const WideString EndTime, const WideString PenID, Single Left, Single Top, Single Right, Single Bottom, Integer StrokeColor, Integer StrokeWidth, Integer Samples) |
| Adds a new ink in the collection.
|
Public Attributes |
Ink | Item |
| Returns the ink at index ItemIndex .
|
IInk | ItemByID |
| Returns the ink whose ID is ItemID .
|
Integer | Count |
| Number of inks in the collection.
|
Detailed Description
This object is a collection of all the inks found in a pattern area.
Member Function Documentation
Integer TInks::Add |
( |
Integer |
PgcID, |
|
|
const WideString |
StartTime, |
|
|
const WideString |
EndTime, |
|
|
const WideString |
PenID, |
|
|
Single |
Left, |
|
|
Single |
Top, |
|
|
Single |
Right, |
|
|
Single |
Bottom, |
|
|
Integer |
StrokeColor, |
|
|
Integer |
StrokeWidth, |
|
|
Integer |
Samples |
|
) |
| |
Adds a new ink in the collection.
- Parameters:
-
PgcID | ID of the PGC that the inks were generated from. |
StartTime | Date and time at which the pen started putting ink, in ISO 8601 format. |
EndTime | Date and time at which the pen started putting ink, in ISO 8601 format. |
PenID | ID of the pen that put the ink. |
Left | Distance from the left edge of the page of the left edge of the bounding box surrounding the ink, in points. |
Top | Distance from the top edge of the page of the top edge of the bounding box surrounding the ink, in points. |
Right | Distance from the right edge of the page of the left edge of the bounding box surrounding the ink, in points. |
Bottom | Distance from the top edge of the page of the bottom edge of the bounding box surrounding the ink, in points. |
StrokeColor | Color of the ink, in RGB. |
StrokeWidth | Width of the line made by the pen, in units of 0.3 mm. |
Samples | Number of sample of the ink. |
- Returns:
- Item ID of the new entry.
Member Data Documentation
Number of inks in the collection.
Returns the ink at index ItemIndex
.
- Note:
- The index of an ink within a collection of inks 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 Ink object to retrieve. |
- See also:
- TInk
Returns the ink whose ID is ItemID
.
- Parameters:
-
ItemID | ID of the Ink object to retrieve. |
- See also:
- TInk