LineDisplayBase Members (POS for .NET v1.12 SDK Documentation)

2/27/2008

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.

The following tables list the members exposed by the LineDisplayBase type.

Protected Constructors

	Name	Description
	LineDisplayBase	Creates an instance of the LineDisplayBase class.

Top

Public Fields

	Name	Description
	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)

Top

Public Properties

(see also Protected Properties )

	Name	Description
	BlinkRate	Overridden. Holds the blink cycle in milliseconds.
	CapBitmap	Overridden. If true, display of bitmaps is supported.
	CapBlink	Overridden. Holds the character blink capability of the line display device.
	CapBlinkRate	Overridden. 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	Overridden. If true, brightness control is supported.
	CapCharacterSet	Overridden. Holds 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 LineDisplayBasic)
	CapCursorType	Overridden. Holds a bitwise indication of the cursor types supported by the line display device, selectable via the CursorType property.
	CapCustomGlyph	Overridden. If true, the device supports custom glyph definition.
	CapDescriptors	Overridden. If true, the device supports descriptors.
	CapHMarquee	Overridden. If true, the device supports horizontal marquee windows.
	CapICharWait	Overridden. If true, the device supports inter-character wait.
	CapMapCharacterSet	Overridden. 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	Gets the power reporting capabilities of the device. (inherited from LineDisplayBasic)
	CapReadBack	Overridden. Holds the capability of the line display device to read back the data displayed on it.
	CapReverse	Overridden. Holds the reverse video capability of the line display device.
	CapScreenMode	Overridden. If true, 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 LineDisplayBasic)
	CapUpdateFirmware	Gets a Boolean value that indicates whether the device's firmware can be updated through the UpdateFirmware method. (inherited from LineDisplayBasic)
	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 LineDisplayBasic)
	CapVMarquee	Overridden. If true, the device supports vertical marquee windows.
	CharacterSet	Overridden. Holds the character set for displaying characters.
	CharacterSetList	Overridden. Holds 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 LineDisplayBasic)
	Columns	Overridden. Holds the number of columns for this window.
	Compatibility	Gets the compatibility level of a device. (inherited from PosDevice)
	CurrentWindow	Overridden.
	CursorColumn	Overridden. Holds the column in the current window to which the next displayed character will be output.
	CursorRow	Overridden. Holds the row in the current window to which the next displayed character will be output.
	CursorType	Overridden. Holds the cursor type for the current window. Possible values are defined by the DisplayCursors enumeration.
	CursorUpdate	Overridden. If true when characters are displayed using the DisplayText and DisplayTextAt methods, then the CursorRow and CursorColumn properties will be updated to point to the character beyond the last character output.
	CustomGlyphList	Overridden. Holds an array of instances of the RangeOfCharacters helper class, which represents the character code ranges that are available for defining glyphs.
	DeviceBrightness	Overridden. Holds the device brightness value, expressed as a percentage between 0 and 100.
	DeviceColumns	Overridden. Holds the number of columns on this device.
	DeviceDescription	Gets a string identifying the device and the company that manufactured it. (inherited from LineDisplayBasic)
	DeviceDescriptors	Overridden. Holds 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 LineDisplayBasic)
	DeviceName	Gets a short string identifying the device and any pertinent information about it. (inherited from LineDisplayBasic)
	DeviceRows	Overridden. Holds the number of rows on this device.
	DeviceWindows	Overridden. Holds the maximum number of windows supported by the line display device.
	FreezeEvents	Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (inherited from LineDisplayBasic)
	GlyphHeight	Overridden. Indicates the glyph height based on the number of pixels for a character cell.
	GlyphWidth	Overridden. Indicates the glyph width based on the number of pixels for a character cell.
	InterCharacterWait	Overridden. Holds the wait time, specified in milliseconds, between the display of each character with the DisplayText and DisplayTextAt methods.
	MapCharacterSet	Overridden. 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	Overridden. Holds the marquee format for the current window.
	MarqueeRepeatWait	Overridden. 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	Overridden. Holds the marquee type for the current window.
	MarqueeUnitWait	Overridden. Holds the wait time, specified in milliseconds, between marquee scrolling of each column or row in the window.
	MaximumX	Overridden. Contains the maximum number of horizontal pixels supported by the device.
	MaximumY	Overridden. Contains the maximum number of vertical pixels supported by the device.
	PowerNotify	Gets or sets the type of power notification selection made by the application. (inherited from LineDisplayBasic)
	PowerState	Gets the current power condition. (inherited from LineDisplayBasic)
	Rows	Overridden. Holds the number of rows for this window.
	ScreenMode	Overridden. Holds the screen mode value of the device.
	ScreenModeList	Overridden. Holds 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 LineDisplayBasic)
	ServiceObjectVersion	Gets the Service Object version number. (inherited from LineDisplayBasic)
	State	Gets the current state of the device. (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)

Top

Protected Properties

	Name	Description
	CommonProperties	(inherited from LineDisplayBasic )
	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.
	CursorVisible
	DeviceInstanceId	(inherited from PosCommon )
	DevicePath	Gets or sets the hardware path of a device. (inherited from PosCommon)
	ExternallyClaimed	(inherited from LineDisplayBasic )
	HardwareId	(inherited from PosCommon )
	IsExclusiveUseDevice	Gets the Boolean value that indicates whether the Line Display device is an exclusive-use device. (inherited from LineDisplay)
	LineDisplayScreenModes
	Properties	Returns an instance of the LineDisplayProperties helper class, containing getters and setters for LineDisplay and common properties.

Top

Public Methods

(see also Protected Methods )

	Name	Description
	CheckHealth	(inherited from PosCommon )
	Claim	(inherited from LineDisplayBasic )
	ClearDescriptors	Overridden. Turns off all descriptors.
	ClearText	Overridden. 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	Clears all windows. (inherited from LineDisplayBasic)
	CompareFirmwareVersion	(inherited from PosCommon )
	CreateWindow	Overridden. Creates a viewport over the portion of the display specified by the first four parameters.
	DefineGlyph	Overridden. Defines a glyph character.
	DestroyWindow	Overridden. Destroys the current window.
	DirectIO	(inherited from PosCommon )
	DisplayBitmap	Overloaded. Overridden.
	DisplayText	Overloaded. Overridden. Displays the specified string of characters.
	DisplayTextAt	Overloaded. Overridden.
	Dispose	Overloaded.
	Equals	Overloaded. (inherited from Object )
	GetHashCode	(inherited from Object )
	GetType	(inherited from Object )
	Open	Overridden. Creates the device window and sets its DeviceBrightness property to 100.
	ReadCharacterAtCursor	Overridden. Reads the currently displayed character at the cursor position.
	ReferenceEquals	(inherited from Object )
	RefreshWindow	Overridden. Changes the current window to the one specified by the window parameter, then redisplays that window’s viewport.
	Release	Releases exclusive access to the device. (inherited from LineDisplayBasic)
	ResetStatistic	(inherited from LineDisplayBasic )
	ResetStatistics	Overloaded. (inherited from LineDisplayBasic )
	RetrieveStatistic	(inherited from LineDisplayBasic )
	RetrieveStatistics	Overloaded. (inherited from LineDisplayBasic )
	ScrollText	Overridden. Scrolls text in the current window, in the specified direction.
	SetBitmap	Overloaded. Overridden.
	SetDescriptor	Overridden. Sets the state of a descriptor.
	ToString	(inherited from Object )
	UpdateFirmware	(inherited from PosCommon )
	UpdateStatistic	(inherited from LineDisplayBasic )
	UpdateStatistics	Overloaded. (inherited from LineDisplayBasic )

Top

Protected Methods

	Name	Description
	ClearDescriptorsImpl	Called by the LineDisplayBase.ClearDescriptors method.
	CreateStatistic	Overloaded. (inherited from LineDisplayBasic )
	DeleteConfigurationProperty	(inherited from PosCommon )
	DisplayData	Called by the LineDisplayBase class to draw the window.
	Dispose	Overloaded. Overridden.
	Finalize	(inherited from Object )
	GetConfigurationProperty	(inherited from PosCommon )
	GetStatisticValue	(inherited from LineDisplayBasic )
	IncrementStatistic	Overloaded. (inherited from LineDisplayBasic )
	Invoke	(inherited from PosCommon )
	MemberwiseClone	(inherited from Object )
	PreFireEvent	Overloaded. (inherited from LineDisplayBasic )
	QueueEvent	Overloaded. (inherited from LineDisplayBasic )
	QueueEventAndWait	(inherited from LineDisplayBasic )
	SetConfigurationProperty	(inherited from PosCommon )
	SetDescriptorImpl	Called by the LineDisplayBase.SetDescriptor method.
	SetStatisticHandlers	(inherited from LineDisplayBasic )
	SetStatisticValue	(inherited from LineDisplayBasic )
	VerifyState	(inherited from LineDisplayBasic )

Top

Public Events

(see also Protected Events )

	Name	Description
	DirectIOEvent	Raised by the Service Object to communicate information directly to the application. (inherited from LineDisplayBasic)
	StatusUpdateEvent	Raised by the Service Object to alert the application of a device status change. (inherited from LineDisplayBasic)

Top

Protected Events

	Name	Description
	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 )
	ScreenModeChangedEvent	Inform the service object that the value of the ScreenMode property has changed.
	StateChangedEvent	(inherited from LineDisplayBasic )

Top

See Also

Reference

LineDisplayBase Class
Microsoft.PointOfService.BaseServiceObjects Namespace

Other Resources

Using Impl Methods for Synchronous or Asynchronous Output