LineDisplayBasic 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.
public abstract class LineDisplayBasic : Microsoft.PointOfService.LineDisplay, IDisposabletype LineDisplayBasic = class
inherit LineDisplay
interface IDisposablePublic MustInherit Class LineDisplayBasic
Inherits LineDisplay
Implements IDisposable- Inheritance
- Derived
- Implements
Constructors
| LineDisplayBasic() |
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 |
Gets or sets the blink cycle in milliseconds. (Inherited from LineDisplay) |
| CapBitmap |
Gets the Boolean value that indicates whether the display of bitmaps is supported. (Inherited from LineDisplay) |
| CapBlink |
Gets the character blink capability of the Line Display device. (Inherited from LineDisplay) |
| CapBlinkRate |
Gets the Boolean value that indicates whether the blink rate of the device can be controlled. (Inherited from LineDisplay) |
| CapBrightness |
Gets the Boolean value that indicates whether brightness can be controlled. (Inherited from LineDisplay) |
| CapCharacterSet |
Gets the default character set capability of the Line Display device. (Inherited from LineDisplay) |
| CapCompareFirmwareVersion | |
| CapCursorType |
Gets a bitwise indication of the cursor types supported by the Line Display device, selectable through the CursorType property. (Inherited from LineDisplay) |
| CapCustomGlyph |
Gets the Boolean value that indicates whether the device support custom glyph definition. (Inherited from LineDisplay) |
| CapDescriptors |
Gets the Boolean value that indicates whether the device supports descriptors. (Inherited from LineDisplay) |
| CapHMarquee |
Gets the Boolean value that indicates whether the device supports horizontal marquee windows. (Inherited from LineDisplay) |
| CapICharWait |
Gets the Boolean value that indicates whether the device supports inter-character wait. (Inherited from LineDisplay) |
| 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. (Inherited from LineDisplay) |
| CapPowerReporting | |
| CapReadBack |
Gets the capability of the Line Display device to read back the data displayed on it. (Inherited from LineDisplay) |
| CapReverse |
Gets the reverse video capability of the Line Display device. (Inherited from LineDisplay) |
| 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. (Inherited from LineDisplay) |
| CapStatisticsReporting | |
| CapUpdateFirmware | |
| CapUpdateStatistics | |
| CapVMarquee |
Gets the Boolean value that indicates whether the device supports vertical marquee windows. (Inherited from LineDisplay) |
| CharacterSet |
Gets or sets the character set for displaying characters. (Inherited from LineDisplay) |
| CharacterSetList |
Gets a string of character set numbers. (Inherited from LineDisplay) |
| CheckHealthText |
Gets a string that indicates the health of the device. (Inherited from PosCommon) |
| Claimed | |
| Columns |
Gets the number of columns for this window. (Inherited from LineDisplay) |
| CommonProperties | |
| Compatibility | (Inherited from PosDevice) |
| CurrentWindow |
Gets or sets the active window to which text is displayed. (Inherited from LineDisplay) |
| CursorColumn |
Gets or sets the column in the active window to which the next displayed character will be output. (Inherited from LineDisplay) |
| CursorRow |
Gets or sets the row in the active window to which the next displayed character is written. (Inherited from LineDisplay) |
| CursorType |
Gets or sets the cursor type for the active window. Possible values are defined by the DisplayCursors enumeration. (Inherited from LineDisplay) |
| CursorUpdate |
Gets or sets the Boolean value that indicates whether characters are updated. (Inherited from LineDisplay) |
| CustomGlyphList |
Gets an array of instances of the RangeOfCharacters helper class, which represents the character code ranges that are available for defining glyphs. (Inherited from LineDisplay) |
| DeviceBrightness |
Gets or sets the device brightness value, expressed as a percentage between 0 and 100. (Inherited from LineDisplay) |
| DeviceColumns |
Gets the number of columns on this device. (Inherited from LineDisplay) |
| DeviceDescription | |
| DeviceDescriptors |
Gets the number of descriptors on this device. (Inherited from LineDisplay) |
| DeviceEnabled | |
| DeviceInstanceId | (Inherited from PosCommon) |
| DeviceName | |
| DevicePath |
Gets or sets the hardware path of a device. (Inherited from PosCommon) |
| DeviceRows |
Gets the number of rows on this device. (Inherited from LineDisplay) |
| DeviceWindows |
Gets the maximum number of windows that the Line Display device supports. (Inherited from LineDisplay) |
| ExternallyClaimed | |
| FreezeEvents | |
| GlyphHeight |
Gets the glyph height based on the number of pixels for a character cell. (Inherited from LineDisplay) |
| GlyphWidth |
Gets the glyph width based on the number of pixels for a character cell. (Inherited from LineDisplay) |
| 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. (Inherited from LineDisplay) |
| IsExclusiveUseDevice |
Gets the Boolean value that indicates whether the Line Display device is an exclusive-use device. (Inherited from LineDisplay) |
| MapCharacterSet |
Gets or sets the Boolean value that indicates whether the Line Display device supports mapping character sets. (Inherited from LineDisplay) |
| MarqueeFormat |
Gets or sets the marquee format for the active window. (Inherited from LineDisplay) |
| 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. (Inherited from LineDisplay) |
| MarqueeType |
Gets or sets the marquee type for the active window. (Inherited from LineDisplay) |
| MarqueeUnitWait |
Gets or sets the wait time, specified in milliseconds, between marquee scrolling of each column or row in the window. (Inherited from LineDisplay) |
| MaximumX |
Gets the maximum number of horizontal pixels that the device supports (Inherited from LineDisplay) |
| MaximumY |
Gets the maximum number of vertical pixels that the device supports. (Inherited from LineDisplay) |
| PowerNotify | |
| PowerState | |
| Rows |
Gets the number of rows for this window. (Inherited from LineDisplay) |
| ScreenMode |
Gets or sets the screen mode value of the device. (Inherited from LineDisplay) |
| ScreenModeList |
Gets the array of DisplayScreenMode class instances that are supported by the device. (Inherited from LineDisplay) |
| ServiceObjectDescription | |
| ServiceObjectVersion | |
| State | |
| 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) | |
| ClearDescriptors() |
Turns off all descriptors. (Inherited from LineDisplay) |
| 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. (Inherited from LineDisplay) |
| Close() | |
| 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) | |
| CreateStatistic(String, Boolean) | |
| CreateWindow(Int32, Int32, Int32, Int32, Int32, Int32) |
Creates a viewport over the part of the display specified by the first four parameters. (Inherited from LineDisplay) |
| DefineGlyph(Int32, Byte[]) |
Defines a glyph character. (Inherited from LineDisplay) |
| DeleteConfigurationProperty(String) |
Deletes the specified property from the XML configuration file. (Inherited from PosCommon) |
| DestroyWindow() |
Destroys the active window. (Inherited from LineDisplay) |
| 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. (Inherited from LineDisplay) |
| DisplayBitmap(String, Int32, Int32) |
Displays the bitmap with the specified alignment. (Inherited from LineDisplay) |
| DisplayText(String, DisplayTextMode) |
Displays the specified string of characters in the specified display mode. (Inherited from LineDisplay) |
| DisplayText(String) |
Displays the specified string of characters. (Inherited from LineDisplay) |
| DisplayTextAt(Int32, Int32, String, DisplayTextMode) |
Displays the string of characters at the specified row and column, in the specified display mode. (Inherited from LineDisplay) |
| DisplayTextAt(Int32, Int32, String) |
Displays the string of characters at the specified row and column. (Inherited from LineDisplay) |
| Dispose() | |
| Dispose(Boolean) | |
| GetConfigurationProperty(String) |
Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon) |
| GetStatisticValue(String) | |
| IncrementStatistic(String, Int32) | |
| IncrementStatistic(String) | |
| Invoke(Delegate, Object[]) |
Used by the Service Objects to raise an event. (Inherited from PosCommon) |
| Open() | |
| PreFireEvent(DirectIOEventArgs) | |
| PreFireEvent(StatusUpdateEventArgs) | |
| QueueEvent(DirectIOEventArgs) | |
| QueueEvent(StatusUpdateEventArgs) | |
| QueueEventAndWait(DirectIOEventArgs) | |
| ReadCharacterAtCursor() |
Reads the currently displayed character at the cursor position. (Inherited from LineDisplay) |
| RefreshWindow(Int32) |
Changes the active window to the one specified by the window parameter, then redisplays that window’s viewport. (Inherited from LineDisplay) |
| Release() | |
| ResetStatistic(String) | |
| ResetStatistics() | |
| ResetStatistics(StatisticCategories) | |
| ResetStatistics(String[]) | |
| RetrieveStatistic(String) | |
| RetrieveStatistics() | |
| RetrieveStatistics(StatisticCategories) | |
| RetrieveStatistics(String[]) | |
| ScrollText(DisplayScrollText, Int32) |
Scrolls text in the active window, in the specified direction. (Inherited from LineDisplay) |
| SetBitmap(Int32, String, Int32, Int32, Int32) |
Sets the bitmap number, placement, and width. (Inherited from LineDisplay) |
| SetBitmap(Int32, String, Int32, Int32) |
Sets the bitmap number and placement. (Inherited from LineDisplay) |
| 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. (Inherited from LineDisplay) |
| SetStatisticHandlers(String, GetStatistic, SetStatistic) | |
| SetStatisticValue(String, Object) | |
| 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) | |
| UpdateStatistics(Statistic[]) | |
| UpdateStatistics(StatisticCategories, Object) | |
| VerifyState(Boolean, Boolean) | |
Events
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent | |
| StateChangedEvent | |
| StatusUpdateEvent | |