C# Keyboard Wedge API Documentation
C# Keyboard Wedge API Documentation
EasyScriptAPI
EasyScript Class
EasyScript Constructor
EasyScript Methods
EasyScript Fields

# EasyScript Class

This is a utility class that can be used to interact with Scriptel ScripTouch EasyScript products. It is capable of parsing and rendering keyboard strings generated when the digitizer is signed.
Inheritance Hierarchy
System
Object
EasyScriptAPI
EasyScript

Namespace: EasyScriptAPI
Assembly: EasyScriptAPI (in EasyScriptAPI.dll) Version: 3.5.29.0 (3.5.29.0)
Syntax
C#
VB
C++
F#
Copy

    public class EasyScript

    Public Class EasyScript

    public ref class EasyScript

    type EasyScript =  class end

The EasyScript type exposes the following members.

Constructors

| Name | Description
--- | --- | ---
| EasyScript | Initializes a new instance of the EasyScript class. Default constructor, uses the STN protocol.
| EasyScript(ISignatureProtocol, ICardSwipeProtocol) | Initializes a new instance of the EasyScript class. Pass in the protocol of the device that you're using.

Top
Methods

| Name | Description
--- | --- | ---
| AddListener | This method accepts a new event listener which will be called when signature or card events are detected in the character stream passed in through ParseSignature().
| GetCardProtocol | Gets the current card swipe protocol
| GetSignatureProtocol | Gets the current signature protocol
| KeyboardEventToChar | This method will attempt to take a keyboard event from either KeyUp or KeyDown and attempt to turn it into its representation in the English - US keyboard layout. This should allow EasyScript devices to work in mixed keyboard environments.
| Parse | This method allows streaming of individual characters to produce streaming signatures using callbacks registered with addListener(). When events are detected in the signature stream events will be sent to the event listeners.
| ParseCardSwipe | This method attempts to parse a magnetic card swipe from a ScripTouch device with a magnetic strip reader.
| ParseSignature | This method takes a EasyScript string and attempts to parse it into a signature object.
| RemoveListener | This method removes an event listener from the list of listeners interested in signature events.
| RenderSignature | This method will take a signature and will attempt to render it onto an Image object.

Top
Fields

| Name | Description
--- | --- | ---
| LibraryBuildDate | This contains the date on which the library was built (YYYY-MM-DD HH:MM:SS).
| LibraryVersion | This contains the current version of the library.

Top
See Also

#### Reference

EasyScriptAPI Namespace