ST1525 Class

ST1525 Class

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

Properties and methods specific to the Scriptel ST1550 signature capture device

The ISTSeriesDevice interface should be used to access members rather than the class object directly.

Inheritance Hierarchy

SystemObject
  Scriptel.STSeriesSTNullDevice
    Scriptel.STSeriesSTSeriesDevice
      Scriptel.STSeriesST15XX
        Scriptel.STSeriesST1500U
          Scriptel.STSeriesST1525

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

Syntax

C++

Copy

public class ST1525 : ST1500U

Public Class ST1525
	Inherits ST1500U

public ref class ST1525 : public ST1500U

type ST1525 =  
    class
        inherit ST1500U
    end

The ST1525 type exposes the following members.

Constructors

	Name	Description
	ST1525	Initializes a new instance of the ST1525 class.

Top

Properties

	Name	Description
	CardReader	Intentionally not implemented. (Inherited from STNullDevice.)
	CurrentDisplay	Gets the instance of the current display. (Inherited from STSeriesDevice.)
	CurrentRunMode	Gets or sets the current run mode of the device (Inherited from STSeriesDevice.)
	DeviceVersionNumber	Gets the version number of the device (Inherited from STSeriesDevice.)
	DisplayHeightInPixels	Gets or sets the height of the display measured in pixels (Inherited from STSeriesDevice.)
	DisplayWidthInPixels	Gets or sets the width of the display measured in pixels (Inherited from STSeriesDevice.)
	FirmwareVersion	Gets the firmware version in the device (Inherited from STSeriesDevice.)
	GetCancelButtonRegionNumber	Gets the region number of the default Cancel button. (Inherited from STSeriesDevice.)
	GetOkButtonRegionNumber	Gets the region number of the default Ok button. (Inherited from STSeriesDevice.)
	IsOpened	Gets if the device is open. (Inherited from STSeriesDevice.)
	IsRegisteredForButtonSelectedEvent	The number of times the ButtonSelected event is registered. This is used for .NET event registration. (Inherited from STSeriesDevice.)
	IsRegisteredForButtonSelectedListener	Gets the number of times the ButtonSelected event is registered. This is used for COM event registration. (Inherited from STSeriesDevice.)
	IsRegisteredForContainerSelectedEvent	The number of times the ContainerSelected event is registered. This is used for .NET event registration. (Inherited from STSeriesDevice.)
	IsRegisteredForContainerSelectedListener	The number of times the ContainerSelected event is registered. This is used for COM event registration. (Inherited from STSeriesDevice.)
	IsRegisteredForDeviceUnpluggedEvent	The number of times the DeviceUnplugged event is registered. This is used for .NET event registration. (Inherited from STSeriesDevice.)
	IsRegisteredForDeviceUnpluggedListener	Gets the number of times the DeviceUnplugged event is registered. This is used for COM event registration. (Inherited from STSeriesDevice.)
	IsRegisteredForFirmwareDownloadStatusEvent	Gets the number of times the FirmwareDownloadStatus event is registered. This is used for .NET event registration. (Inherited from STSeriesDevice.)
	IsRegisteredForFirmwareDownloadStatusListener	Gets how many times the FirmwareDownloadStatus event is registered for. This is used for COM event registration. (Inherited from STSeriesDevice.)
	NativeInputHeight	Gets the native height of the input surface. (Inherited from ST15XX.)
	NativeInputWidth	Gets the native width of the input surface. (Inherited from ST15XX.)
	ProductID	Gets the product ID of the device (Inherited from STSeriesDevice.)
	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 (Inherited from STSeriesDevice.)

Top

Methods

	Name	Description
	AddButtonSelectedEventListener	Increments the IsRegisteredForButtonSelectedListener property and signals for button coordinates to start being stored in the buffer. Used for COM. (Inherited from STSeriesDevice.)
	AddContainerSelectedEventListener	Increments the IsRegisteredForContainerSelectedListener property and signals for container coordinates to start being stored in the buffer. Used for COM. (Inherited from STSeriesDevice.)
	Close	Closes the device to free up resources. (Inherited from STSeriesDevice.)
	DownloadErrorCorrectionTable	Intentionally not implemented. (Inherited from STNullDevice.)
	DownloadErrorCorrectionTableFromString	Downloads the error correction information specified (Inherited from STSeriesDevice.)
	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. (Inherited from STSeriesDevice.)
	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. (Inherited from STSeriesDevice.)
	GetBoolButtonProperty	Gets the boolean button property. (Inherited from STSeriesDevice.)
	GetCalibrationState	Gets the current calibration state (Inherited from STSeriesDevice.)
	GetCoordinatePacket	Gets the first coordinate from the coordinate buffer and removes that coordinate from the buffer. Used for COM. (Inherited from STSeriesDevice.)
	GetCurrentDisplay	Gets the current ISTSeriesDeviceDisplay from the ISTSeriesDevice. (Inherited from STSeriesDevice.)
	GetDefaultRegions	Gets the default regions. (Inherited from STSeriesDevice.)
	GetDeviceSerialNumber	Gets the serial number currently in the device (Inherited from STSeriesDevice.)
	GetErrorCorrectionTable	Intentionally not implemented. (Inherited from STNullDevice.)
	GetNamedButtonRegionNumbers	Gets the region numbers of the buttons containing the named text. (Inherited from STSeriesDevice.)
	GetRegion	(Inherited from STSeriesDevice.)
	GetTextButtonProperty	Gets the boolean button property. (Inherited from STSeriesDevice.)
	Open	Opens the device for use (Inherited from STSeriesDevice.)
	RegisterForButtonSelectedEvent	Registers a target event handler for the ButtonSelected event (Inherited from STSeriesDevice.)
	RegisterForContainerSelectedEvent	Registers a target event handler for the ContainerSelected event (Inherited from STSeriesDevice.)
	RegisterForDeviceUnpluggedEvent	Registers a target event handler for the DeviceUnplugged event (Inherited from STSeriesDevice.)
	RegisterForFirmwareDownloadStatusEvent	Registers a target event handler for the FirmwareDownloadStatus event (Inherited from STSeriesDevice.)
	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. (Inherited from STSeriesDevice.)
	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. (Inherited from STSeriesDevice.)
	RenderImageAsBW	Renders the specified image onto the device. Supports BMP, GIF, JPEG, PNG, and TIFF. (Inherited from ST15XX.)
	RenderImageAsGray	Renders the specified image onto the device in 4 bit greyscale. Supports BMP, GIF, JPEG, PNG, and TIFF. (Inherited from ST15XX.)
	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. (Inherited from STSeriesDevice.)
	SetDeviceSerialNumber	Writes the serial number to the device. (Inherited from STSeriesDevice.)
	SetRegionDimensions	(Inherited from STSeriesDevice.)
	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. (Inherited from STSeriesDevice.)
	StartCalibration	Puts the device in calibration mode (Inherited from STSeriesDevice.)
	StartCalibration(Int32)	Puts the device in calibration mode (Inherited from STSeriesDevice.)
	StartReading	Starts reading coordinate information from the device and sends the information via ButtonSelected and ContainerSelected events. Uses the current run mode. (Inherited from ST1500U.)
	StartReading(STSeriesDeviceRunMode)	Starts reading coordinate information from the device and sends the information via ButtonSelected and ContainerSelected events. Uses the selected run mode. (Inherited from STSeriesDevice.)
	StartWorkflow	Starts the given workflow on this device (Inherited from STSeriesDevice.)
	StopCalibration	Aborts calibration mode (Inherited from STSeriesDevice.)
	StopReading	Stops reading coordinate information from the device and keeps the current run mode (Inherited from STSeriesDevice.)
	StopReading(STSeriesDeviceRunMode)	Stops reading coordinate information from the device and changes the run mode to that specified (Inherited from STSeriesDevice.)
	StopWorkflow	Stops the current workflow if one exists (Inherited from STSeriesDevice.)
	UnregisterForButtonSelectedEvent	Unregisters a target event handler for the ButtonSelected event (Inherited from STSeriesDevice.)
	UnregisterForContainerSelectedEvent	Unregisters a target event handler for the ContainerSelected event (Inherited from STSeriesDevice.)
	UnregisterForDeviceUnpluggedEvent	Unregisters a target event handler for the DeviceUnplugged event (Inherited from STSeriesDevice.)
	UnregisterForFirmwareDownloadStatusEvent	Unregisters a target event handler for the FirmwareDownloadStatus event (Inherited from STSeriesDevice.)

Top

Reference

Scriptel.STSeries Namespace