Click or drag to resize
ST1501BPYJ ClassScriptel Corporation
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 ST1501 signature capture device

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

Inheritance Hierarchy

Namespace: Scriptel.STSeries
Assembly: STSeries (in STSeries.dll) Version: 2.5.0.454 (2.5.0.454)
Syntax
public class ST1501BPYJ : ST15XX

The ST1501BPYJ type exposes the following members.

Constructors
  NameDescription
Public methodST1501BPYJ
Initializes a new instance of the ST1501 class.
Top
Properties
  NameDescription
Public propertyCardReader
Intentionally not implemented.
(Inherited from STNullDevice.)
Public propertyCurrentDisplay
Gets the instance of the current display.
(Inherited from STSeriesDevice.)
Public propertyCurrentRunMode
Gets or sets the current run mode of the device
(Inherited from STSeriesDevice.)
Public propertyDeviceVersionNumber
Gets the version number of the device
(Inherited from STSeriesDevice.)
Public propertyDisplayHeightInPixels
Gets or sets the height of the display measured in pixels
(Inherited from STSeriesDevice.)
Public propertyDisplayWidthInPixels
Gets or sets the width of the display measured in pixels
(Inherited from STSeriesDevice.)
Public propertyFirmwareVersion
Gets the firmware version in the device
(Inherited from STSeriesDevice.)
Public propertyGetCancelButtonRegionNumber
Gets the region number of the default Cancel button.
(Inherited from STSeriesDevice.)
Public propertyGetOkButtonRegionNumber
Gets the region number of the default Ok button.
(Inherited from STSeriesDevice.)
Public propertyIsOpened
Gets if the device is open.
(Inherited from STSeriesDevice.)
Public propertyIsRegisteredForButtonSelectedEvent
The number of times the ButtonSelected event is registered. This is used for .NET event registration.
(Inherited from STSeriesDevice.)
Public propertyIsRegisteredForButtonSelectedListener
Gets the number of times the ButtonSelected event is registered. This is used for COM event registration.
(Inherited from STSeriesDevice.)
Public propertyIsRegisteredForContainerSelectedEvent
The number of times the ContainerSelected event is registered. This is used for .NET event registration.
(Inherited from STSeriesDevice.)
Public propertyIsRegisteredForContainerSelectedListener
The number of times the ContainerSelected event is registered. This is used for COM event registration.
(Inherited from STSeriesDevice.)
Public propertyIsRegisteredForDeviceUnpluggedEvent
The number of times the DeviceUnplugged event is registered. This is used for .NET event registration.
(Inherited from STSeriesDevice.)
Public propertyIsRegisteredForDeviceUnpluggedListener
Gets the number of times the DeviceUnplugged event is registered. This is used for COM event registration.
(Inherited from STSeriesDevice.)
Public propertyIsRegisteredForFirmwareDownloadStatusEvent
Gets the number of times the FirmwareDownloadStatus event is registered. This is used for .NET event registration.
(Inherited from STSeriesDevice.)
Public propertyIsRegisteredForFirmwareDownloadStatusListener
Gets how many times the FirmwareDownloadStatus event is registered for. This is used for COM event registration.
(Inherited from STSeriesDevice.)
Public propertyNativeInputHeight
Gets the native height of the input surface.
(Inherited from ST15XX.)
Public propertyNativeInputWidth
Gets the native width of the input surface.
(Inherited from ST15XX.)
Public propertyProductID
Gets the product ID of the device
(Inherited from STSeriesDevice.)
Public propertySerialNumberWriteEnabled
Gets a value indicating whether or not a serial number download is supported
(Inherited from STNullDevice.)
Public propertyVendorID
Gets the vendor ID of the device
(Inherited from STSeriesDevice.)
Top
Methods
  NameDescription
Public methodAddButtonSelectedEventListener
Increments the IsRegisteredForButtonSelectedListener property and signals for button coordinates to start being stored in the buffer. Used for COM.
(Inherited from STSeriesDevice.)
Public methodAddContainerSelectedEventListener
Increments the IsRegisteredForContainerSelectedListener property and signals for container coordinates to start being stored in the buffer. Used for COM.
(Inherited from STSeriesDevice.)
Public methodClose
Closes the device to free up resources.
(Inherited from STSeriesDevice.)
Public methodDownloadErrorCorrectionTable
Intentionally not implemented.
(Inherited from STNullDevice.)
Public methodDownloadErrorCorrectionTableFromString
Downloads the error correction information specified
(Inherited from STSeriesDevice.)
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.

(Inherited from STSeriesDevice.)
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.

(Inherited from STSeriesDevice.)
Public methodGetBoolButtonProperty
Gets the boolean button property.
(Inherited from STSeriesDevice.)
Public methodGetCalibrationState
Gets the current calibration state
(Inherited from STSeriesDevice.)
Public methodGetCoordinatePacket
Gets the first coordinate from the coordinate buffer and removes that coordinate from the buffer. Used for COM.
(Inherited from STSeriesDevice.)
Public methodGetCurrentDisplay
Gets the current ISTSeriesDeviceDisplay from the ISTSeriesDevice.
(Inherited from STSeriesDevice.)
Public methodGetDefaultRegions
Gets the default regions.
(Inherited from STSeriesDevice.)
Public methodGetDeviceSerialNumber
Gets the serial number currently in the device
(Inherited from STSeriesDevice.)
Public methodGetErrorCorrectionTable
Intentionally not implemented.
(Inherited from STNullDevice.)
Public methodGetNamedButtonRegionNumbers
Gets the region numbers of the buttons containing the named text.
(Inherited from STSeriesDevice.)
Public methodGetRegion (Inherited from STSeriesDevice.)
Public methodGetTextButtonProperty
Gets the boolean button property.
(Inherited from STSeriesDevice.)
Public methodOpen
Opens the device for use
(Inherited from STSeriesDevice.)
Public methodRegisterForButtonSelectedEvent
Registers a target event handler for the ButtonSelected event
(Inherited from STSeriesDevice.)
Public methodRegisterForContainerSelectedEvent
Registers a target event handler for the ContainerSelected event
(Inherited from STSeriesDevice.)
Public methodRegisterForDeviceUnpluggedEvent
Registers a target event handler for the DeviceUnplugged event
(Inherited from STSeriesDevice.)
Public methodRegisterForFirmwareDownloadStatusEvent
Registers a target event handler for the FirmwareDownloadStatus event
(Inherited from STSeriesDevice.)
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.
(Inherited from STSeriesDevice.)
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.
(Inherited from STSeriesDevice.)
Public methodRenderImageAsBW
Renders the specified image onto the device. Supports BMP, GIF, JPEG, PNG, and TIFF.
(Inherited from ST15XX.)
Public methodRenderImageAsGray
Renders the specified image onto the device in 4 bit greyscale. Supports BMP, GIF, JPEG, PNG, and TIFF.
(Inherited from ST15XX.)
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.
(Inherited from STSeriesDevice.)
Public methodSetDeviceSerialNumber
Writes the serial number to the device.
(Inherited from STSeriesDevice.)
Public methodSetRegionDimensions (Inherited from STSeriesDevice.)
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.
(Inherited from STSeriesDevice.)
Public methodStartCalibration
Puts the device in calibration mode
(Inherited from STSeriesDevice.)
Public methodStartCalibration(Int32)
Puts the device in calibration mode
(Inherited from STSeriesDevice.)
Public methodStartReading
Starts reading coordinate information from the device and sends the information via ButtonSelected and ContainerSelected events. Uses the current run mode.
(Inherited from STSeriesDevice.)
Public methodStartReading(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.)
Public methodStartWorkflow
Starts the given workflow on this device
(Inherited from STSeriesDevice.)
Public methodStopCalibration
Aborts calibration mode
(Inherited from STSeriesDevice.)
Public methodStopReading
Stops reading coordinate information from the device and keeps the current run mode
(Inherited from STSeriesDevice.)
Public methodStopReading(STSeriesDeviceRunMode)
Stops reading coordinate information from the device and changes the run mode to that specified
(Inherited from STSeriesDevice.)
Public methodStopWorkflow
Stops the current workflow if one exists
(Inherited from STSeriesDevice.)
Public methodUnregisterForButtonSelectedEvent
Unregisters a target event handler for the ButtonSelected event
(Inherited from STSeriesDevice.)
Public methodUnregisterForContainerSelectedEvent
Unregisters a target event handler for the ContainerSelected event
(Inherited from STSeriesDevice.)
Public methodUnregisterForDeviceUnpluggedEvent
Unregisters a target event handler for the DeviceUnplugged event
(Inherited from STSeriesDevice.)
Public methodUnregisterForFirmwareDownloadStatusEvent
Unregisters a target event handler for the FirmwareDownloadStatus event
(Inherited from STSeriesDevice.)
Top
See Also