PlanetPress Capture Library
TInk Class Reference

This object represents a series of pen strokes that are tied together and which are located in the same pattern area. More...

List of all members.

Public Member Functions

 AsEPS (const WideString OutputFilename)
 Generates an EPS file of the ink.

Public Attributes

Integer ID
 ID of the Ink.
WideString StartTimeUTC
 Date and time when the user started writing, in ISO 8601 format.
WideString EndTimeUTC
 Date and time when the user stopped writing, in ISO 8601 format.
WideString PenID
 Serial number of the pen that wrote the ink.
Single Left
 Distance of the left edge of the box surrounding the ink from the left edge of the page, in points.
Single Top
 Distance of the top edge of the box surrounding the ink from the top edge of the page, in points.
Single Right
 Distance of the right edge of the box surrounding the ink from the left edge of the page, in points.
Single Bottom
 Distance of the bottom edge of the box surrounding the ink from the top edge of the page, in points.
Integer StrokeColor
 Color of the ink, in RGB.
Integer StrokeWidth
 Width of the ink line, in units of 0.3 mm.
WordBool Selected
 Indicates whether the ink is to be be rendered or not.
WideString StartTimeLocal
 Date and time when the user started writing, in local time format.
WideString EndTimeLocal
 Date and time when the user stopped writing, in local time format.
Integer SampleCount
 Number of samples recorded by the pen.

Detailed Description

This object represents a series of pen strokes that are tied together and which are located in the same pattern area.

An ink begins when a pen stroke is first found in an area and ends either when the stroke style changes (e.g. width or color) or when the PGC file is closed.


Member Function Documentation

TInk::AsEPS ( const WideString  OutputFilename)

Generates an EPS file of the ink.

Parameters:
OutputFilenameName of the file where to save the EPS.

Member Data Documentation

Single TInk::Bottom

Distance of the bottom edge of the box surrounding the ink from the top edge of the page, in points.

WideString TInk::EndTimeLocal

Date and time when the user stopped writing, in local time format.

See also:
EndTimeUTC
WideString TInk::EndTimeUTC

Date and time when the user stopped writing, in ISO 8601 format.

The user stops writing when:

  • the pen is docked;
  • the style of the pen is changed (stroke width or color).
Integer TInk::ID

ID of the Ink.

Single TInk::Left

Distance of the left edge of the box surrounding the ink from the left edge of the page, in points.

WideString TInk::PenID

Serial number of the pen that wrote the ink.

See also:
TPen
Single TInk::Right

Distance of the right edge of the box surrounding the ink from the left edge of the page, in points.

Number of samples recorded by the pen.

WordBool TInk::Selected

Indicates whether the ink is to be be rendered or not.

Date and time when the user started writing, in local time format.

See also:
StartTimeUTC
WideString TInk::StartTimeUTC

Date and time when the user started writing, in ISO 8601 format.

Color of the ink, in RGB.

Width of the ink line, in units of 0.3 mm.

Single TInk::Top

Distance of the top edge of the box surrounding the ink from the top edge of the page, in points.