Click or drag to resize
STSeriesDevice MethodsScriptel Corporation
Warning: This API is deprecated, please consider using the new version located here: http://scriptel.com/developers/proscript/net-library/

The STSeriesDevice type exposes the following members.

Methods
  NameDescription
Public methodAddButtonSelectedEventListener
Increments the IsRegisteredForButtonSelectedListener property and signals for button coordinates to start being stored in the buffer. Used for COM.
(Overrides STNullDevice.AddButtonSelectedEventListener.)
Public methodAddContainerSelectedEventListener
Increments the IsRegisteredForContainerSelectedListener property and signals for container coordinates to start being stored in the buffer. Used for COM.
(Overrides STNullDevice.AddContainerSelectedEventListener.)
Public methodClose
Closes the device to free up resources.
(Overrides STNullDevice.Close.)
Public methodDownloadErrorCorrectionTable
Intentionally not implemented.
(Inherited from STNullDevice.)
Public methodDownloadErrorCorrectionTableFromString
Downloads the error correction information specified
Public methodDownloadFirmware(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).)
Public methodDownloadFirmware(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).)
Public methodGetBoolButtonProperty
Gets the boolean button property.
(Overrides STNullDevice.GetBoolButtonProperty(Int32, STSeriesDeviceButtonProperty).)
Public methodGetCalibrationState
Gets the current calibration state
(Overrides STNullDevice.GetCalibrationState.)
Public methodGetCoordinatePacket
Gets the first coordinate from the coordinate buffer and removes that coordinate from the buffer. Used for COM.
(Overrides STNullDevice.GetCoordinatePacket(Int32, ISTSignaturePoint).)
Public methodGetCurrentDisplay
Gets the current ISTSeriesDeviceDisplay from the ISTSeriesDevice.
Public methodGetDefaultRegions
Gets the default regions.
Public methodGetDeviceSerialNumber
Gets the serial number currently in the device
(Overrides STNullDeviceGetDeviceSerialNumber.)
Public methodGetErrorCorrectionTable
Intentionally not implemented.
(Inherited from STNullDevice.)
Public methodGetNamedButtonRegionNumbers
Gets the region numbers of the buttons containing the named text.
Public methodGetRegion
Public methodGetTextButtonProperty
Gets the boolean button property.
(Overrides STNullDevice.GetTextButtonProperty(Int32, STSeriesDeviceButtonProperty).)
Public methodOpen
Opens the device for use
(Overrides STNullDevice.Open.)
Public methodRegisterForButtonSelectedEvent
Registers a target event handler for the ButtonSelected event
(Overrides STNullDevice.RegisterForButtonSelectedEvent(Object, STNullDeviceButtonSelectedEventHandler).)
Public methodRegisterForContainerSelectedEvent
Registers a target event handler for the ContainerSelected event
(Overrides STNullDevice.RegisterForContainerSelectedEvent(Object, STNullDeviceContainerSelectedEventHandler).)
Public methodRegisterForDeviceUnpluggedEvent
Registers a target event handler for the DeviceUnplugged event
(Overrides STNullDevice.RegisterForDeviceUnpluggedEvent(Object, EventHandler).)
Public methodRegisterForFirmwareDownloadStatusEvent
Registers a target event handler for the FirmwareDownloadStatus event
(Overrides STNullDevice.RegisterForFirmwareDownloadStatusEvent(Object, STNullDeviceFirmwareDownloadStatusEventHandler).)
Public methodRemoveButtonSelectedEventListener
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.)
Public methodRemoveContainerSelectedEventListener
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.)
Public methodSetBoolButtonProperty
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).)
Public methodSetDeviceSerialNumber
Writes the serial number to the device.
(Overrides STNullDevice.SetDeviceSerialNumber(String).)
Public methodSetRegionDimensions (Overrides STNullDeviceSetRegionDimensions(Int32, Int32, Int32, Int32, Int32).)
Public methodSetTextButtonProperty
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).)
Public methodStartCalibration
Puts the device in calibration mode
(Overrides STNullDevice.StartCalibration.)
Public methodStartCalibration(Int32)
Puts the device in calibration mode
Public methodStartReading
Starts reading coordinate information from the device and sends the information via ButtonSelected and ContainerSelected events. Uses the current run mode.
(Overrides STNullDevice.StartReading.)
Public methodStartReading(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).)
Public methodStartWorkflow
Starts the given workflow on this device
Public methodStopCalibration
Aborts calibration mode
(Overrides STNullDeviceStopCalibration.)
Public methodStopReading
Stops reading coordinate information from the device and keeps the current run mode
(Overrides STNullDevice.StopReading.)
Public methodStopReading(STSeriesDeviceRunMode)
Stops reading coordinate information from the device and changes the run mode to that specified
Public methodStopWorkflow
Stops the current workflow if one exists
Public methodUnregisterForButtonSelectedEvent
Unregisters a target event handler for the ButtonSelected event
(Overrides STNullDevice.UnregisterForButtonSelectedEvent(Object, STNullDeviceButtonSelectedEventHandler).)
Public methodUnregisterForContainerSelectedEvent
Unregisters a target event handler for the ContainerSelected event
(Overrides STNullDevice.UnregisterForContainerSelectedEvent(Object, STNullDeviceContainerSelectedEventHandler).)
Public methodUnregisterForDeviceUnpluggedEvent
Unregisters a target event handler for the DeviceUnplugged event
(Overrides STNullDevice.UnregisterForDeviceUnpluggedEvent(Object, EventHandler).)
Public methodUnregisterForFirmwareDownloadStatusEvent
Unregisters a target event handler for the FirmwareDownloadStatus event
(Overrides STNullDevice.UnregisterForFirmwareDownloadStatusEvent(Object, STNullDeviceFirmwareDownloadStatusEventHandler).)
Top
See Also