STSeriesDevice Class

Warning: This API is deprecated, please consider using the new version located here: http://scriptel.com/developers/proscript/net-library/

Properties and methods that generally apply to any Scriptel ST1500 Series device

This class should not be used directly. Either use the ISTSeriesDevice interface to access members and properties, or use the interface for one of the device specific classes such as the IST1500U interface.

Inheritance Hierarchy

SystemObject
  Scriptel.STSeriesSTNullDevice
    Scriptel.STSeriesSTSeriesDevice
      Scriptel.STSeriesST15XX
      Scriptel.STSeriesSTSeriesDeviceContainerDevice

Namespace: Scriptel.STSeries
Assembly: STSeries (in STSeries.dll) Version: 2.5.0.454 (2.5.0.454)

Syntax

C++

Copy

public abstract class STSeriesDevice : STNullDevice, 
	ISTSeriesDevice

Public MustInherit Class STSeriesDevice
	Inherits STNullDevice
	Implements ISTSeriesDevice

public ref class STSeriesDevice abstract : public STNullDevice, 
	ISTSeriesDevice

[<AbstractClassAttribute>]
type STSeriesDevice =  
    class
        inherit STNullDevice
        interface ISTSeriesDevice
    end

The STSeriesDevice type exposes the following members.

Constructors

	Name	Description
	STSeriesDevice	Interface for receiving events about firmware downloads.

Top

Properties

	Name	Description
	CardReader	Intentionally not implemented. (Inherited from STNullDevice.)
	CurrentDisplay	Gets the instance of the current display. (Overrides STNullDevice.CurrentDisplay.)
	CurrentRunMode	Gets or sets the current run mode of the device
	DeviceVersionNumber	Gets the version number of the device (Overrides STNullDevice.DeviceVersionNumber.)
	DisplayHeightInPixels	Gets or sets the height of the display measured in pixels
	DisplayWidthInPixels	Gets or sets the width of the display measured in pixels
	FirmwareVersion	Gets the firmware version in the device (Overrides STNullDevice.FirmwareVersion.)
	GetCancelButtonRegionNumber	Gets the region number of the default Cancel button. (Overrides STNullDevice.GetCancelButtonRegionNumber.)
	GetOkButtonRegionNumber	Gets the region number of the default Ok button. (Overrides STNullDevice.GetOkButtonRegionNumber.)
	IsOpened	Gets if the device is open. (Overrides STNullDevice.IsOpened.)
	IsRegisteredForButtonSelectedEvent	The number of times the ButtonSelected event is registered. This is used for .NET event registration. (Overrides STNullDevice.IsRegisteredForButtonSelectedEvent.)
	IsRegisteredForButtonSelectedListener	Gets the number of times the ButtonSelected event is registered. This is used for COM event registration.
	IsRegisteredForContainerSelectedEvent	The number of times the ContainerSelected event is registered. This is used for .NET event registration. (Overrides STNullDevice.IsRegisteredForContainerSelectedEvent.)
	IsRegisteredForContainerSelectedListener	The number of times the ContainerSelected event is registered. This is used for COM event registration. (Overrides STNullDevice.IsRegisteredForContainerSelectedListener.)
	IsRegisteredForDeviceUnpluggedEvent	The number of times the DeviceUnplugged event is registered. This is used for .NET event registration. (Overrides STNullDevice.IsRegisteredForDeviceUnpluggedEvent.)
	IsRegisteredForDeviceUnpluggedListener	Gets the number of times the DeviceUnplugged event is registered. This is used for COM event registration.
	IsRegisteredForFirmwareDownloadStatusEvent	Gets the number of times the FirmwareDownloadStatus event is registered. This is used for .NET event registration.
	IsRegisteredForFirmwareDownloadStatusListener	Gets how many times the FirmwareDownloadStatus event is registered for. This is used for COM event registration.
	ProductID	Gets the product ID of the device (Overrides STNullDevice.ProductID.)
	SerialNumberWriteEnabled	Gets a value indicating whether or not a serial number download is supported (Inherited from STNullDevice.)
	VendorID	Gets the vendor ID of the device (Overrides STNullDevice.VendorID.)

Top

Methods

	Name	Description
	AddButtonSelectedEventListener	Increments the IsRegisteredForButtonSelectedListener property and signals for button coordinates to start being stored in the buffer. Used for COM. (Overrides STNullDevice.AddButtonSelectedEventListener.)
	AddContainerSelectedEventListener	Increments the IsRegisteredForContainerSelectedListener property and signals for container coordinates to start being stored in the buffer. Used for COM. (Overrides STNullDevice.AddContainerSelectedEventListener.)
	Close	Closes the device to free up resources. (Overrides STNullDevice.Close.)
	DownloadErrorCorrectionTable	Intentionally not implemented. (Inherited from STNullDevice.)
	DownloadErrorCorrectionTableFromString	Downloads the error correction information specified
	DownloadFirmware(Byte)	Downloads firmware to the device. The device needs to be reset upon completion of the download. Registering for FirmwareDownloadStatusEvent is suggested Unplugging the device while downloading firmware will damage it. (Overrides STNullDevice.DownloadFirmware(Byte).)
	DownloadFirmware(String)	Downloads firmware to the device. The device needs to be reset upon completion of the download. Registering for FirmwareDownloadStatusEvent is suggested Unplugging the device while downloading firmware will damage it. (Overrides STNullDevice.DownloadFirmware(String).)
	GetBoolButtonProperty	Gets the boolean button property. (Overrides STNullDevice.GetBoolButtonProperty(Int32, STSeriesDeviceButtonProperty).)
	GetCalibrationState	Gets the current calibration state (Overrides STNullDevice.GetCalibrationState.)
	GetCoordinatePacket	Gets the first coordinate from the coordinate buffer and removes that coordinate from the buffer. Used for COM. (Overrides STNullDevice.GetCoordinatePacket(Int32, ISTSignaturePoint).)
	GetCurrentDisplay	Gets the current ISTSeriesDeviceDisplay from the ISTSeriesDevice.
	GetDefaultRegions	Gets the default regions.
	GetDeviceSerialNumber	Gets the serial number currently in the device (Overrides STNullDeviceGetDeviceSerialNumber.)
	GetErrorCorrectionTable	Intentionally not implemented. (Inherited from STNullDevice.)
	GetNamedButtonRegionNumbers	Gets the region numbers of the buttons containing the named text.
	GetRegion
	GetTextButtonProperty	Gets the boolean button property. (Overrides STNullDevice.GetTextButtonProperty(Int32, STSeriesDeviceButtonProperty).)
	Open	Opens the device for use (Overrides STNullDevice.Open.)
	RegisterForButtonSelectedEvent	Registers a target event handler for the ButtonSelected event (Overrides STNullDevice.RegisterForButtonSelectedEvent(Object, STNullDeviceButtonSelectedEventHandler).)
	RegisterForContainerSelectedEvent	Registers a target event handler for the ContainerSelected event (Overrides STNullDevice.RegisterForContainerSelectedEvent(Object, STNullDeviceContainerSelectedEventHandler).)
	RegisterForDeviceUnpluggedEvent	Registers a target event handler for the DeviceUnplugged event (Overrides STNullDevice.RegisterForDeviceUnpluggedEvent(Object, EventHandler).)
	RegisterForFirmwareDownloadStatusEvent	Registers a target event handler for the FirmwareDownloadStatus event (Overrides STNullDevice.RegisterForFirmwareDownloadStatusEvent(Object, STNullDeviceFirmwareDownloadStatusEventHandler).)
	RemoveButtonSelectedEventListener	Decrements the IsRegisteredForButtonSelectedListener property and if no one else is listening for button coordinates from the buffer then coordinates no longer are placed in the coordinate buffer. Used for COM. (Overrides STNullDevice.RemoveButtonSelectedEventListener.)
	RemoveContainerSelectedEventListener	Decrements the IsRegisteredForContainerSelectedListener property and if no one else is listening for container coordinates from the buffer then coordinates no longer are placed in the coordinate buffer. Used for COM. (Overrides STNullDevice.RemoveContainerSelectedEventListener.)
	SetBoolButtonProperty	Sets the button properties. Support for many of these operations are only available in firmware version 2.2.3 and later. Usage of the functions in earlier firmware can result in incorrect behavior. (Overrides STNullDevice.SetBoolButtonProperty(Int32, STSeriesDeviceButtonProperty, Boolean).)
	SetDeviceSerialNumber	Writes the serial number to the device. (Overrides STNullDevice.SetDeviceSerialNumber(String).)
	SetRegionDimensions	(Overrides STNullDeviceSetRegionDimensions(Int32, Int32, Int32, Int32, Int32).)
	SetTextButtonProperty	Sets the button properties. Support for many of these operations are only available in firmware version 2.2.3 and later. Usage of the functions in earlier firmware can result in incorrect behavior. (Overrides STNullDevice.SetTextButtonProperty(Int32, STSeriesDeviceButtonProperty, String).)
	StartCalibration	Puts the device in calibration mode (Overrides STNullDevice.StartCalibration.)
	StartCalibration(Int32)	Puts the device in calibration mode
	StartReading	Starts reading coordinate information from the device and sends the information via ButtonSelected and ContainerSelected events. Uses the current run mode. (Overrides STNullDevice.StartReading.)
	StartReading(STSeriesDeviceRunMode)	Starts reading coordinate information from the device and sends the information via ButtonSelected and ContainerSelected events. Uses the selected run mode. (Overrides STNullDevice.StartReading(STSeriesDeviceRunMode).)
	StartWorkflow	Starts the given workflow on this device
	StopCalibration	Aborts calibration mode (Overrides STNullDeviceStopCalibration.)
	StopReading	Stops reading coordinate information from the device and keeps the current run mode (Overrides STNullDevice.StopReading.)
	StopReading(STSeriesDeviceRunMode)	Stops reading coordinate information from the device and changes the run mode to that specified
	StopWorkflow	Stops the current workflow if one exists
	UnregisterForButtonSelectedEvent	Unregisters a target event handler for the ButtonSelected event (Overrides STNullDevice.UnregisterForButtonSelectedEvent(Object, STNullDeviceButtonSelectedEventHandler).)
	UnregisterForContainerSelectedEvent	Unregisters a target event handler for the ContainerSelected event (Overrides STNullDevice.UnregisterForContainerSelectedEvent(Object, STNullDeviceContainerSelectedEventHandler).)
	UnregisterForDeviceUnpluggedEvent	Unregisters a target event handler for the DeviceUnplugged event (Overrides STNullDevice.UnregisterForDeviceUnpluggedEvent(Object, EventHandler).)
	UnregisterForFirmwareDownloadStatusEvent	Unregisters a target event handler for the FirmwareDownloadStatus event (Overrides STNullDevice.UnregisterForFirmwareDownloadStatusEvent(Object, STNullDeviceFirmwareDownloadStatusEventHandler).)

Top

Reference

Scriptel.STSeries Namespace