RemoteOrderDisplay 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.
Defines the programmatic interface for a remote order display.
public abstract class RemoteOrderDisplay : Microsoft.PointOfService.PosCommontype RemoteOrderDisplay = class
inherit PosCommonPublic MustInherit Class RemoteOrderDisplay
Inherits PosCommon- Inheritance
- Derived
Constructors
| RemoteOrderDisplay() |
Creates an instance of the RemoteOrderDisplay class. |
Fields
| CharacterSetAnsi |
A constant value that is used by the SelectCharacterSet(DeviceUnits, Int32) method to set the video unit to use the ANSI character set. |
| CharacterSetAscii |
A constant value used by the SelectCharacterSet(DeviceUnits, Int32) method to set the video unit to use the ASCII character set. |
| CharacterSetUnicode |
A constant value that is used by the SelectCharacterSet(DeviceUnits, Int32) method to set the video unit to use the Unicode character set. |
| ClockAll |
A constant value that is used by the ControlClock method to set all clocks to start at the same time. |
| ExtendedErrorBadClock |
Indicates a Pause, Resume, Start, Stop, or Move command was requested on an uninitialized clockId for any of the video units indicated in units. |
| 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) |
| ExtendedErrorNoBuffers |
Indicates the requested buffer exceeds the total number of video save buffers the remote order display device can support at once as specified in the SystemVideoSaveBuffers property. |
| ExtendedErrorNoClocks |
Indicates the total number of clocks the remote order display device can support at one time as specified in the SystemClocks property has been reached. |
| ExtendedErrorNoRegion |
Indicates bufferId does not contain a previously saved video region for the selected units. |
| ExtendedErrorNoRoom |
Indicates all the buffer memory has been allocated for a specific unit. The ErrorUnits and ErrorString properties are updated. |
| ExtendedErrorStatistics |
Indicates a specified statistic could not be reset or updated. (Inherited from PosCommon) |
| ExtendedErrorStatisticsDependency | (Inherited from PosCommon) |
| 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) |
| 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
| AsyncMode |
Gets or sets a Boolean value that indicates whether methods are performed asynchronously. |
| AutoToneDuration |
Gets or sets the duration (in milliseconds) of the automatic tone for the video unit specified by the CurrentUnitId property. |
| AutoToneFrequency |
Gets or sets the frequency (in Hertz) of the automatic tone for the video unit specified by the CurrentUnitId property. |
| 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) |
| CapMapCharacterSet |
Gets a Boolean value that indicates whether the service object can map characters to the character sets that are defined in CharacterSetList. |
| CapPowerReporting |
Gets the power reporting capabilities of the device. (Inherited from PosCommon) |
| CapSelectCharacterSet |
Gets a Boolean value that indicates whether the video unit specified by the CurrentUnitId property can be loaded with an alternate, user-supplied character set. |
| CapStatisticsReporting |
Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (Inherited from PosCommon) |
| CapTone |
Gets a Boolean value that indicates whether the video unit specified by the CurrentUnitId property supports an enunciator. |
| CapTouch |
Gets a Boolean value that indicates whether the video unit specified by the CurrentUnitId property supports the TouchUp, TouchDown, and TouchMove event types. |
| CapTransaction |
Gets a Boolean value that indicates whether transactions are supported by each video unit. |
| 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) |
| CharacterSet |
Gets the character set for displaying characters for the video unit specified by the CurrentUnitId property. |
| CharacterSetList |
Gets the character set for the video unit specified by the CurrentUnitId property. |
| 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) |
| Clocks |
Gets the number of clocks the video unit, specified by the CurrentUnitId property, can support. |
| Compatibility | (Inherited from PosDevice) |
| CurrentUnitId |
Gets or sets the current video unit ID. Up to 32 units are allowed on one remote order display device. The unit ID definitions range from Unit1 to Unit32. |
| DataCount |
Gets the total number of queued DataEvent events. |
| DataEventEnabled |
Gets or sets a Boolean value that indicates whether a DataEvent event is delivered when input data is queued. |
| DeviceDescription |
Gets a string identifying the device and the company that manufactured it. (Inherited from PosCommon) |
| 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) |
| ErrorString |
Gets an error description that occurred to the video units. |
| ErrorUnits |
Gets a bitwise mask of the video units that encountered an error. |
| EventString |
Gets an error description for an error event. |
| EventType |
Gets or sets event types. |
| EventUnitId |
Gets a video unit ID. |
| EventUnits |
Gets device unit(s). |
| FreezeEvents |
Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (Inherited from PosCommon) |
| HardwareId | (Inherited from PosCommon) |
| IsExclusiveUseDevice | |
| MapCharacterSet |
Gets or sets a Boolean value that indicates whether transferred characters are mapped to another character set. |
| OutputId |
Gets the identifier of the most recently started asynchronous output. |
| 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) |
| 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) |
| SystemClocks |
Gets the total number of clocks the remote order display device can support at one time. |
| SystemVideoSaveBuffers |
Gets the total number of video save buffers the remote order display device can support at one time. |
| Timeout |
Gets or sets the timeout value in milliseconds used by the remote order display device to complete all supported output methods. |
| UnitsOnline |
Gets which video units are online. |
| VideoDataCount |
Gets the number of DataEvent events queued for the video unit specified by the CurrentUnitId property. |
| VideoMode |
Gets or sets the video Mode ID selected for the video unit specified by the CurrentUnitId property. |
| VideoModesList |
Gets the video modes supported for the video unit specified by the CurrentUnitId property. |
| VideoSaveBuffers |
Gets the number of save buffers for the video unit specified by the CurrentUnitId property. |
Methods
| CheckHealth(HealthCheckLevel) |
Tests the state of a device. (Inherited from PosCommon) |
| Claim(Int32) |
Requests exclusive access to the device. (Inherited from PosCommon) |
| ClearInput() |
Clears the device input that has been buffered for the unit specified by the CurrentUnitId property. |
| ClearOutput() |
Clears all outputs that have been buffered for the unit specified by the CurrentUnitId property. This includes video and tone outputs. |
| ClearVideo(DeviceUnits, VideoAttributes) |
Clears the display area for the video unit(s) specified by the units parameter. |
| ClearVideoRegion(DeviceUnits, Int32, Int32, Int32, Int32, VideoAttributes) | |
| 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) |
| ControlClock(DeviceUnits, ClockFunction, Int32, Int32, Int32, Int32, Int32, Int32, VideoAttributes, ClockMode) |
Performs the clock command requested in clockFunction on the specified video unit(s). |
| ControlCursor(DeviceUnits, VideoCursorType) |
Enables or disables the cursor for the specified video unit(s). |
| CopyVideoRegion(DeviceUnits, Int32, Int32, Int32, Int32, Int32, Int32) |
Copies a region of the display area to a new location on the display area for the specified video unit(s). |
| DeleteConfigurationProperty(String) |
Deletes the specified property from the XML configuration file. (Inherited from PosCommon) |
| DirectIO(Int32, Int32, Object) |
Used to communicate directly with the Service Object. (Inherited from PosCommon) |
| DisplayData(DeviceUnits, Int32, Int32, VideoAttributes, String) |
Displays the characters in data starting at the location that is specified by row and column, and continues in succeeding columns on the video unit(s) indicated in the units parameter. |
| DrawBox(DeviceUnits, Int32, Int32, Int32, Int32, VideoAttributes, BorderType) |
Draws a box on the specified video unit(s). |
| FreeVideoRegion(DeviceUnits, Int32) |
Frees any buffer memory allocated for the specified video unit(s). |
| 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) |
| 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) |
| ResetVideo(DeviceUnits) |
Sets the specified video unit(s) to a turned on state. |
| RestoreVideoRegion(DeviceUnits, Int32, Int32, Int32) |
Restores a previously saved video region of the display area from the requested bufferId for the specified video unit(s). |
| 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) |
| SaveVideoRegion(DeviceUnits, Int32, Int32, Int32, Int32, Int32) |
Saves the specified video region of the display area to one of the provided video buffers for the specified video unit(s). |
| SelectCharacterSet(DeviceUnits, Int32) |
Selects a compatible character set for the specified video unit(s). |
| SetConfigurationProperty(String, String) |
Sets a property value (or create a new property) in the XML configuration file. (Inherited from PosCommon) |
| SetCursor(DeviceUnits, Int32, Int32) |
Updates the cursor position on the specified video unit(s). |
| TransactionDisplay(DeviceUnits, RemoteOrderDisplayTransaction) |
Enters or exits transaction mode for the specified video unit(s). |
| 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) |
| UpdateVideoRegionAttribute(DeviceUnits, VideoAttributeCommand, Int32, Int32, Int32, Int32, VideoAttributes) | |
| VideoSound(DeviceUnits, Int32, Int32, Int32, Int32) |
Sounds the video enunciator for the specified units. |
Events
| DataEvent |
Notifies the application when input data from a video touch unit is available. |
| DeviceAddedEvent | (Inherited from PosCommon) |
| DeviceRemovedEvent | (Inherited from PosCommon) |
| DirectIOEvent |
Raised by the Service Object to communicate information directly to the application. (Inherited from PosCommon) |
| ErrorEvent |
Notifies the application that a remote order display error has been detected and a suitable response by the application is necessary to process the error condition. |
| OutputCompleteEvent |
Notifies the application that the queued output request associated with the OutputID property has completed successfully. |
| StatusUpdateEvent |
Raised by the Service Object to alert the application of a device status change. (Inherited from PosCommon) |