LineDisplay Class

Definition

Namespace:

Microsoft.PointOfService

Assembly:

Microsoft.PointOfService.dll

Defines the programmatic interface for a UPOS Line Display device.

public abstract class LineDisplay : Microsoft.PointOfService.PosCommon

type LineDisplay = class
    inherit PosCommon

Public MustInherit Class LineDisplay
Inherits PosCommon

Inheritance

Object

PosDevice

PosCommon

LineDisplay

Derived

Microsoft.PointOfService.BasicServiceObjects.LineDisplayBasic

Constructors

LineDisplay()

Creates an instance of the LineDisplay class.

Fields

CharacterSetAnsi	Indicates the default character set is ANSI.
CharacterSetAscii	Indicates the default character set is ASCII.
CharacterSetUnicode	Indicates the default character set is Unicode.
DisplayBitmapAsIs	Displays the bitmap with one bitmap pixel per dot.
DisplayBitmapBottom	Aligns the bitmap’s bottom edge with the bottommost pixel of the current character position, as specified by the CursorRow property setting.
DisplayBitmapCenter	Aligns the bitmap in the horizontal center of the current character position, as specified by the CursorColumn property setting.
DisplayBitmapLeft	Aligns the bitmap’s left edge with the leftmost pixel of the current character position, as specified by the CursorColumn property setting.
DisplayBitmapRight	Aligns the bitmap’s right edge with the rightmost pixel of the current character position, as specified by the CursorColumn property setting.
DisplayBitmapTop	Aligns the bitmap’s top edge with the topmost pixel of the current character position, as specified by the CursorRow property setting.
ExtendedErrorBadFormat	Indicates that the specified file is either not a bitmap file or it is in an unsupported format.
ExtendedErrorFirmwareBadFile	Indicates the specified firmware file or files exist, but one or more of those files are either not in the correct format or are corrupted. (Inherited from PosCommon)
ExtendedErrorStatistics	Indicates a specified statistic could not be reset or updated. (Inherited from PosCommon)
ExtendedErrorStatisticsDependency	(Inherited from PosCommon)
ExtendedErrorTooBig	Indicates that the bitmap is either too wide to display without transformation, or it is too big to transform.
StatisticCommunicationErrorCount	Holds the programmatic name of the Communication Error Count common statistic. (Inherited from PosCommon)
StatisticDeviceCategory	Holds the programmatic name of the Device Category common statistic. (Inherited from PosCommon)
StatisticFirmwareRevision	Holds the programmatic name of the Firmware Revision common statistic. (Inherited from PosCommon)
StatisticHoursPoweredCount	Holds the programmatic name of the Hours Powered On common statistic. (Inherited from PosCommon)
StatisticInstallationDate	Holds the programmatic name of the Installation Date common statistic. (Inherited from PosCommon)
StatisticInterface	Holds the programmatic name of the Interface common statistic. (Inherited from PosCommon)
StatisticManufactureDate	Holds the programmatic name of the Manufacture Date common statistic. (Inherited from PosCommon)
StatisticManufacturerName	Holds the programmatic name of the Manufacturer Name common statistic. (Inherited from PosCommon)
StatisticMechanicalRevision	Holds the programmatic name of the Mechanical Revision common statistic. (Inherited from PosCommon)
StatisticModelName	Holds the programmatic name of the Model Name common statistic. (Inherited from PosCommon)
StatisticOnlineTransitionCount	Incremented when data is successfully drawn in the line display window.
StatisticSerialNumber	Holds the programmatic name of the Serial Number common statistic. (Inherited from PosCommon)
StatisticUnifiedPOSVersion	Holds the programmatic name of the Unified POS Version common statistic. (Inherited from PosCommon)
StatusPowerOff	Indicates that the device’s power is turned off or it is detached from the terminal. (Inherited from PosCommon)
StatusPowerOffline	Indicates that the device is powered on but is either not ready or unable to respond to requests. (Inherited from PosCommon)
StatusPowerOffOffline	Indicates that either the device’s power is off or it is offline. (Inherited from PosCommon)
StatusPowerOnline	Indicates that the device’s power is turned on and it is ready for use. (Inherited from PosCommon)
StatusUpdateFirmwareComplete	Indicates the update firmware process has completed successfully. (Inherited from PosCommon)
StatusUpdateFirmwareCompleteDeviceNotRestored	Indicates the update firmware process succeeded. However, the Service Object and/or the physical device cannot be returned to the state they were in before the update firmware process started. (Inherited from PosCommon)
StatusUpdateFirmwareFailedDeviceNeedsFirmware	Indicates the update firmware process failed. The device will not be operational until another attempt to update the firmware is successful. (Inherited from PosCommon)
StatusUpdateFirmwareFailedDeviceOk	Indicates the update firmware process failed. However, the device is still operational. (Inherited from PosCommon)
StatusUpdateFirmwareFailedDeviceUnknown	Indicates the update firmware process failed. The device is in an indeterminate state. (Inherited from PosCommon)
StatusUpdateFirmwareFailedDeviceUnrecoverable	Indicates the update firmware process failed. The device is either unusable or unrecoverable through software. (Inherited from PosCommon)
StatusUpdateFirmwareProgress	Indicates the update firmware process has completed 1 to 100 percent successfully. (Inherited from PosCommon)
WaitForever	Used as the value for a timeout parameter in common and device-specific methods to indicate the method should wait until it receives a response, instead of timing out. (Inherited from PosCommon)

Properties

BlinkRate	Gets or sets the blink cycle in milliseconds.
CapBitmap	Gets the Boolean value that indicates whether the display of bitmaps is supported.
CapBlink	Gets the character blink capability of the Line Display device.
CapBlinkRate	Gets the Boolean value that indicates whether the blink rate of the device can be controlled.
CapBrightness	Gets the Boolean value that indicates whether brightness can be controlled.
CapCharacterSet	Gets the default character set capability of the Line Display device.
CapCompareFirmwareVersion	Gets a Boolean value that indicates whether the Service Object/device supports comparing the firmware version in the physical device against that of a firmware file. (Inherited from PosCommon)
CapCursorType	Gets a bitwise indication of the cursor types supported by the Line Display device, selectable through the CursorType property.
CapCustomGlyph	Gets the Boolean value that indicates whether the device support custom glyph definition.
CapDescriptors	Gets the Boolean value that indicates whether the device supports descriptors.
CapHMarquee	Gets the Boolean value that indicates whether the device supports horizontal marquee windows.
CapICharWait	Gets the Boolean value that indicates whether the device supports inter-character wait.
CapMapCharacterSet	Gets the Boolean value that indicates whether the service object can map the characters provided by the application to the character sets defined in the CharacterSetList property when displaying data.
CapPowerReporting	Gets the power reporting capabilities of the device. (Inherited from PosCommon)
CapReadBack	Gets the capability of the Line Display device to read back the data displayed on it.
CapReverse	Gets the reverse video capability of the Line Display device.
CapScreenMode	Gets the Boolean value that indicates whether the Line Display device supports changing the screen mode; that is, the number of text rows and columns.
CapStatisticsReporting	Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (Inherited from PosCommon)
CapUpdateFirmware	Gets a Boolean value that indicates whether the device's firmware can be updated through the UpdateFirmware method. (Inherited from PosCommon)
CapUpdateStatistics	Gets a Boolean value that indicates whether some or all the device statistics can be reset to 0 (zero) by using the ResetStatistic and ResetStatistics methods, or updated by using the UpdateStatistic and UpdateStatistics methods. (Inherited from PosCommon)
CapVMarquee	Gets the Boolean value that indicates whether the device supports vertical marquee windows.
CharacterSet	Gets or sets the character set for displaying characters.
CharacterSetList	Gets a string of character set numbers.
CheckHealthText	Gets a string that indicates the health of the device. (Inherited from PosCommon)
Claimed	Gets a Boolean value that indicates whether the device is claimed for exclusive access. (Inherited from PosCommon)
Columns	Gets the number of columns for this window.
Compatibility	(Inherited from PosDevice)
CurrentWindow	Gets or sets the active window to which text is displayed.
CursorColumn	Gets or sets the column in the active window to which the next displayed character will be output.
CursorRow	Gets or sets the row in the active window to which the next displayed character is written.
CursorType	Gets or sets the cursor type for the active window. Possible values are defined by the DisplayCursors enumeration.
CursorUpdate	Gets or sets the Boolean value that indicates whether characters are updated.
CustomGlyphList	Gets an array of instances of the RangeOfCharacters helper class, which represents the character code ranges that are available for defining glyphs.
DeviceBrightness	Gets or sets the device brightness value, expressed as a percentage between 0 and 100.
DeviceColumns	Gets the number of columns on this device.
DeviceDescription	Gets a string identifying the device and the company that manufactured it. (Inherited from PosCommon)
DeviceDescriptors	Gets the number of descriptors on this device.
DeviceEnabled	Gets or sets a Boolean value that indicates whether the device has been placed in an operational state. (Inherited from PosCommon)
DeviceInstanceId	(Inherited from PosCommon)
DeviceName	Gets a short string identifying the device and any pertinent information about it. (Inherited from PosCommon)
DevicePath	Gets or sets the hardware path of a device. (Inherited from PosCommon)
DeviceRows	Gets the number of rows on this device.
DeviceWindows	Gets the maximum number of windows that the Line Display device supports.
FreezeEvents	Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (Inherited from PosCommon)
GlyphHeight	Gets the glyph height based on the number of pixels for a character cell.
GlyphWidth	Gets the glyph width based on the number of pixels for a character cell.
HardwareId	(Inherited from PosCommon)
InterCharacterWait	Gets or sets the wait time, specified in milliseconds, between the display of each character with the DisplayText(String) and DisplayTextAt(Int32, Int32, String) methods.
IsExclusiveUseDevice	Gets the Boolean value that indicates whether the Line Display device is an exclusive-use device.
MapCharacterSet	Gets or sets the Boolean value that indicates whether the Line Display device supports mapping character sets.
MarqueeFormat	Gets or sets the marquee format for the active window.
MarqueeRepeatWait	Gets or sets the wait time, specified in milliseconds, between scrolling the final character or row of the window into its viewport and restarting the marquee with the first or last character or row.
MarqueeType	Gets or sets the marquee type for the active window.
MarqueeUnitWait	Gets or sets the wait time, specified in milliseconds, between marquee scrolling of each column or row in the window.
MaximumX	Gets the maximum number of horizontal pixels that the device supports
MaximumY	Gets the maximum number of vertical pixels that the device supports.
PowerNotify	Gets or sets the type of power notification selection made by the application. (Inherited from PosCommon)
PowerState	Gets the current power condition. (Inherited from PosCommon)
Rows	Gets the number of rows for this window.
ScreenMode	Gets or sets the screen mode value of the device.
ScreenModeList	Gets the array of DisplayScreenMode class instances that are supported by the device.
ServiceObjectDescription	Gets a string identifying the Service Object that supports the device and the company that produced it. (Inherited from PosCommon)
ServiceObjectVersion	Gets the Service Object version number. (Inherited from PosCommon)
State	Gets the current state of the device. (Inherited from PosCommon)
SynchronizingObject	Gets or sets the object that is used to marshal the event handler calls issued because of a POS event. (Inherited from PosCommon)

Methods

CheckHealth(HealthCheckLevel)	Tests the state of a device. (Inherited from PosCommon)
Claim(Int32)	Requests exclusive access to the device. (Inherited from PosCommon)
ClearDescriptors()	Turns off all descriptors.
ClearText()	Clears the active window by displaying blanks, sets the CursorRow and CursorColumn properties to zero, and then resynchronizes the beginning of the window with the start of the viewport.
Close()	Releases the device and its resources. (Inherited from PosCommon)
CompareFirmwareVersion(String)	Determines whether the version of the specified firmware is newer than, older than, or the same as the version of firmware in the physical device. (Inherited from PosCommon)
CreateWindow(Int32, Int32, Int32, Int32, Int32, Int32)	Creates a viewport over the part of the display specified by the first four parameters.
DefineGlyph(Int32, Byte[])	Defines a glyph character.
DeleteConfigurationProperty(String)	Deletes the specified property from the XML configuration file. (Inherited from PosCommon)
DestroyWindow()	Destroys the active window.
DirectIO(Int32, Int32, Object)	Used to communicate directly with the Service Object. (Inherited from PosCommon)
DisplayBitmap(String, Int32, Int32, Int32)	Displays the bitmap with the specified alignment and width.
DisplayBitmap(String, Int32, Int32)	Displays the bitmap with the specified alignment.
DisplayText(String, DisplayTextMode)	Displays the specified string of characters in the specified display mode.
DisplayText(String)	Displays the specified string of characters.
DisplayTextAt(Int32, Int32, String, DisplayTextMode)	Displays the string of characters at the specified row and column, in the specified display mode.
DisplayTextAt(Int32, Int32, String)	Displays the string of characters at the specified row and column.
GetConfigurationProperty(String)	Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon)
Invoke(Delegate, Object[])	Used by the Service Objects to raise an event. (Inherited from PosCommon)
Open()	Opens a device for later input/output processing. (Inherited from PosCommon)
ReadCharacterAtCursor()	Reads the currently displayed character at the cursor position.
RefreshWindow(Int32)	Changes the active window to the one specified by the window parameter, then redisplays that window’s viewport.
Release()	Releases exclusive access to the device. (Inherited from PosCommon)
ResetStatistic(String)	Resets the specified statistic to 0 (zero). (Inherited from PosCommon)
ResetStatistics()	Resets all statistics associated with a device to 0 (zero). (Inherited from PosCommon)
ResetStatistics(StatisticCategories)	Resets all statistics for a specified category to 0 (zero). (Inherited from PosCommon)
ResetStatistics(String[])	Resets the specified statistics to 0 (zero). (Inherited from PosCommon)
RetrieveStatistic(String)	Retrieves the specified device statistic. (Inherited from PosCommon)
RetrieveStatistics()	Retrieves all device statistics. (Inherited from PosCommon)
RetrieveStatistics(StatisticCategories)	Retrieves the statistics for the specified category. (Inherited from PosCommon)
RetrieveStatistics(String[])	Retrieves the specified statistics. (Inherited from PosCommon)
ScrollText(DisplayScrollText, Int32)	Scrolls text in the active window, in the specified direction.
SetBitmap(Int32, String, Int32, Int32, Int32)	Sets the bitmap number, placement, and width.
SetBitmap(Int32, String, Int32, Int32)	Sets the bitmap number and placement.
SetConfigurationProperty(String, String)	Sets a property value (or create a new property) in the XML configuration file. (Inherited from PosCommon)
SetDescriptor(Int32, DisplaySetDescriptor)	Sets the state of a descriptor.
UpdateFirmware(String)	Updates the firmware of a device with the version of the firmware contained or defined in the file specified by the firmwareFileName parameter regardless of whether that firmware’s version is newer than, older than, or the same as the version of the firmware already in the device. (Inherited from PosCommon)
UpdateStatistic(String, Object)	Updates the value of a specified device statistic. (Inherited from PosCommon)
UpdateStatistics(Statistic[])	Updates a list of statistics with the corresponding specified values. (Inherited from PosCommon)
UpdateStatistics(StatisticCategories, Object)	Updates the specified category of statistics with the specified value. (Inherited from PosCommon)

Events

DeviceAddedEvent	(Inherited from PosCommon)
DeviceRemovedEvent	(Inherited from PosCommon)
DirectIOEvent	Raised by the Service Object to communicate information directly to the application. (Inherited from PosCommon)
StatusUpdateEvent	Raised by the Service Object to alert the application of a device status change. (Inherited from PosCommon)