LineDisplayBase Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Contains most of the functionality required for support of Line Display devices, including drawing of text and graphics (glyphs and bitmaps), window management, and scrolling, marquee, and teletype functions.
public abstract class LineDisplayBase : Microsoft.PointOfService.BasicServiceObjects.LineDisplayBasictype LineDisplayBase = class
inherit LineDisplayBasicPublic MustInherit Class LineDisplayBase
Inherits LineDisplayBasic- Inheritance
Constructors
| LineDisplayBase() |
Creates an instance of the LineDisplayBase class. |
Fields
| CharacterSetAnsi |
Indicates the default character set is ANSI. (Inherited from LineDisplay) |
| CharacterSetAscii |
Indicates the default character set is ASCII. (Inherited from LineDisplay) |
| CharacterSetUnicode |
Indicates the default character set is Unicode. (Inherited from LineDisplay) |
| DisplayBitmapAsIs |
Displays the bitmap with one bitmap pixel per dot. (Inherited from LineDisplay) |
| DisplayBitmapBottom |
Aligns the bitmap’s bottom edge with the bottommost pixel of the current character position, as specified by the CursorRow property setting. (Inherited from LineDisplay) |
| DisplayBitmapCenter |
Aligns the bitmap in the horizontal center of the current character position, as specified by the CursorColumn property setting. (Inherited from LineDisplay) |
| DisplayBitmapLeft |
Aligns the bitmap’s left edge with the leftmost pixel of the current character position, as specified by the CursorColumn property setting. (Inherited from LineDisplay) |
| DisplayBitmapRight |
Aligns the bitmap’s right edge with the rightmost pixel of the current character position, as specified by the CursorColumn property setting. (Inherited from LineDisplay) |
| DisplayBitmapTop |
Aligns the bitmap’s top edge with the topmost pixel of the current character position, as specified by the CursorRow property setting. (Inherited from LineDisplay) |
| ExtendedErrorBadFormat |
Indicates that the specified file is either not a bitmap file or it is in an unsupported format. (Inherited from LineDisplay) |
| 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. (Inherited from LineDisplay) |
| 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. (Inherited from LineDisplay) |
| 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 |
Holds the blink cycle in milliseconds. |
| CapBitmap |
If true, display of bitmaps is supported. |
| CapBlink |
Holds the character blink capability of the line display device. |
| CapBlinkRate |
If true, the device’s blink rate can be controlled, and the application uses the BlinkRate property to indicate the rate at which the display blinks. |
| CapBrightness |
If true, brightness control is supported. |
| CapCharacterSet |
Holds the default character set capability of the line display device. |
| CapCompareFirmwareVersion | (Inherited from LineDisplayBasic) |
| CapCursorType |
Holds a bitwise indication of the cursor types supported by the line display device, selectable via the CursorType property. |
| CapCustomGlyph |
If true, the device supports custom glyph definition. |
| CapDescriptors |
If true, the device supports descriptors. |
| CapHMarquee |
If true, the device supports horizontal marquee windows. |
| CapICharWait |
If true, the device supports inter-character wait. |
| CapMapCharacterSet |
If true, then the service object is able to map the characters provided by the application to the character sets defined in the CharacterSetList property when displaying data. |
| CapPowerReporting | (Inherited from LineDisplayBasic) |
| CapReadBack |
Holds the capability of the line display device to read back the data displayed on it. |
| CapReverse |
Holds the reverse video capability of the line display device. |
| CapScreenMode |
If true, the line display device supports changing the screen mode (that is, the number of text rows and columns). |
| CapStatisticsReporting | (Inherited from LineDisplayBasic) |
| CapUpdateFirmware | (Inherited from LineDisplayBasic) |
| CapUpdateStatistics | (Inherited from LineDisplayBasic) |
| CapVMarquee |
If true, the device supports vertical marquee windows. |
| CharacterSet |
Holds the character set for displaying characters. |
| CharacterSetList |
Holds a string of character set numbers. |
| CheckHealthText |
Gets a string that indicates the health of the device. (Inherited from PosCommon) |
| Claimed | (Inherited from LineDisplayBasic) |
| Columns |
Holds the number of columns for this window. |
| CommonProperties | (Inherited from LineDisplayBasic) |
| Compatibility | (Inherited from PosDevice) |
| CurrentWindow | |
| CursorColumn |
Holds the column in the current window to which the next displayed character will be output. |
| CursorDeviceColumn |
Translates the CursorColumn value into a device coordinate by returning an integer that represents the value of the CursorColumn property added to the current window’s start column value. |
| CursorDeviceRow |
Translates the CursorRow value into a device coordinate by returning an integer that represents the value of the CursorRow property added to the current window’s start row value. |
| CursorRow |
Holds the row in the current window to which the next displayed character will be output. |
| CursorType |
Holds the cursor type for the current window. Possible values are defined by the DisplayCursors enumeration. |
| CursorUpdate |
If true when characters are displayed using the DisplayText(String) and DisplayTextAt(Int32, Int32, String) methods, then the CursorRow and CursorColumn properties will be updated to point to the character beyond the last character output. |
| CursorVisible | |
| CustomGlyphList |
Holds an array of instances of the RangeOfCharacters helper class, which represents the character code ranges that are available for defining glyphs. |
| DeviceBrightness |
Holds the device brightness value, expressed as a percentage between 0 and 100. |
| DeviceColumns |
Holds the number of columns on this device. |
| DeviceDescription | (Inherited from LineDisplayBasic) |
| DeviceDescriptors |
Holds the number of descriptors on this device. |
| DeviceEnabled | (Inherited from LineDisplayBasic) |
| DeviceInstanceId | (Inherited from PosCommon) |
| DeviceName | (Inherited from LineDisplayBasic) |
| DevicePath |
Gets or sets the hardware path of a device. (Inherited from PosCommon) |
| DeviceRows |
Holds the number of rows on this device. |
| DeviceWindows |
Holds the maximum number of windows supported by the line display device. |
| ExternallyClaimed | (Inherited from LineDisplayBasic) |
| FreezeEvents | (Inherited from LineDisplayBasic) |
| GlyphHeight |
Indicates the glyph height based on the number of pixels for a character cell. |
| GlyphWidth |
Indicates the glyph width based on the number of pixels for a character cell. |
| HardwareId | (Inherited from PosCommon) |
| InterCharacterWait |
Holds 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. (Inherited from LineDisplay) |
| LineDisplayScreenModes | |
| MapCharacterSet |
If true, then the service object is able to map the characters provided by the application to the character sets defined in the CharacterSetList property when displaying data. |
| MarqueeFormat |
Holds the marquee format for the current window. |
| MarqueeRepeatWait |
Holds 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 |
Holds the marquee type for the current window. |
| MarqueeUnitWait |
Holds the wait time, specified in milliseconds, between marquee scrolling of each column or row in the window. |
| MaximumX |
Contains the maximum number of horizontal pixels supported by the device. |
| MaximumY |
Contains the maximum number of vertical pixels supported by the device. |
| PowerNotify | (Inherited from LineDisplayBasic) |
| PowerState | (Inherited from LineDisplayBasic) |
| Properties |
Returns an instance of the LineDisplayProperties helper class, containing getters and setters for LineDisplay and common properties. |
| Rows |
Holds the number of rows for this window. |
| ScreenMode |
Holds the screen mode value of the device. |
| ScreenModeList |
Holds the array of DisplayScreenMode class instances that are supported by the device. |
| ServiceObjectDescription | (Inherited from LineDisplayBasic) |
| ServiceObjectVersion | (Inherited from LineDisplayBasic) |
| State | (Inherited from LineDisplayBasic) |
| 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) | (Inherited from LineDisplayBasic) |
| ClearDescriptors() |
Turns off all descriptors. |
| ClearDescriptorsImpl() |
Called by the LineDisplayBase.ClearDescriptors method. |
| ClearText() |
Clears the current 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() | (Inherited from LineDisplayBasic) |
| 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) |
| CreateStatistic(String, Boolean, String) | (Inherited from LineDisplayBasic) |
| CreateStatistic(String, Boolean) | (Inherited from LineDisplayBasic) |
| CreateWindow(Int32, Int32, Int32, Int32, Int32, Int32) |
Creates a viewport over the portion 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 current 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. |
| DisplayData(Cell[]) |
Called by the LineDisplayBase class to draw the window. |
| DisplayText(String, DisplayTextMode) | |
| DisplayText(String) | |
| 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. |
| Dispose() | (Inherited from LineDisplayBasic) |
| Dispose(Boolean) | |
| GetConfigurationProperty(String) |
Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon) |
| GetStatisticValue(String) | (Inherited from LineDisplayBasic) |
| IncrementStatistic(String, Int32) | (Inherited from LineDisplayBasic) |
| IncrementStatistic(String) | (Inherited from LineDisplayBasic) |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| Open() |
Creates the device window and sets its DeviceBrightness property to 100. |
| PreFireEvent(DirectIOEventArgs) | (Inherited from LineDisplayBasic) |
| PreFireEvent(StatusUpdateEventArgs) | (Inherited from LineDisplayBasic) |
| QueueEvent(DirectIOEventArgs) | (Inherited from LineDisplayBasic) |
| QueueEvent(StatusUpdateEventArgs) | (Inherited from LineDisplayBasic) |
| QueueEventAndWait(DirectIOEventArgs) | (Inherited from LineDisplayBasic) |
| ReadCharacterAtCursor() |
Reads the currently displayed character at the cursor position. |
| RefreshWindow(Int32) |
Changes the current window to the one specified by the window parameter, then redisplays that window’s viewport. |
| Release() | (Inherited from LineDisplayBasic) |
| ResetStatistic(String) | (Inherited from LineDisplayBasic) |
| ResetStatistics() | (Inherited from LineDisplayBasic) |
| ResetStatistics(StatisticCategories) | (Inherited from LineDisplayBasic) |
| ResetStatistics(String[]) | (Inherited from LineDisplayBasic) |
| RetrieveStatistic(String) | (Inherited from LineDisplayBasic) |
| RetrieveStatistics() | (Inherited from LineDisplayBasic) |
| RetrieveStatistics(StatisticCategories) | (Inherited from LineDisplayBasic) |
| RetrieveStatistics(String[]) | (Inherited from LineDisplayBasic) |
| ScrollText(DisplayScrollText, Int32) |
Scrolls text in the current 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. |
| SetDescriptorImpl(Int32, DisplaySetDescriptor) |
Called by the LineDisplayBase.SetDescriptor method. |
| SetStatisticHandlers(String, GetStatistic, SetStatistic) | (Inherited from LineDisplayBasic) |
| SetStatisticValue(String, Object) | (Inherited from LineDisplayBasic) |
| 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) | (Inherited from LineDisplayBasic) |
| UpdateStatistics(Statistic[]) | (Inherited from LineDisplayBasic) |
| UpdateStatistics(StatisticCategories, Object) | (Inherited from LineDisplayBasic) |
| VerifyState(Boolean, Boolean) | (Inherited from LineDisplayBasic) |
Events
| BlinkRateChangedEvent |
Informs the service object that the value of the BlinkRate property has changed. |
| CurrentWindowChangedEvent |
Informs the service object that the value of the CurrentWindow property has changed. |
| CursorTypeChangedEvent |
Inform the service object that the value of the CursorType property has changed. |
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent | (Inherited from LineDisplayBasic) |
| ScreenModeChangedEvent |
Inform the service object that the value of the ScreenMode property has changed. |
| StateChangedEvent | (Inherited from LineDisplayBasic) |
| StatusUpdateEvent | (Inherited from LineDisplayBasic) |