RemoteOrderDisplay Members (POS for .NET v1.12 SDK Documentation)
2/27/2008
Defines the programmatic interface for a remote order display.
The following tables list the members exposed by the RemoteOrderDisplay type.
Protected Constructors
| Name | Description | |
|---|---|---|
| RemoteOrderDisplay | Creates an instance of the RemoteOrderDisplay class. |
Top
Public Fields
| Name | Description | |
|---|---|---|
.gif "Aa460868.pubfield(en-US,WinEmbedded.11).gif") .gif "Aa460868.static(en-US,WinEmbedded.11).gif") |
CharacterSetAnsi | A constant value that is used by the SelectCharacterSet method to set the video unit to use the ANSI character set. |
|
CharacterSetAscii | A constant value used by the SelectCharacterSet method to set the video unit to use the ASCII character set. |
|
CharacterSetUnicode | A constant value that is used by the SelectCharacterSet 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) |
Top
Public Properties
(see also Protected Properties )
| Name | Description | |
|---|---|---|
.gif "Aa460868.pubproperty(en-US,WinEmbedded.11).gif") |
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 | Gets the compatibility level of a device. (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) |
|
DeviceName | Gets a short string identifying the device and any pertinent information about it. (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) |
|
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. |
Top
Protected Properties
| Name | Description | |
|---|---|---|
.gif "Aa460868.protproperty(en-US,WinEmbedded.11).gif") |
DeviceInstanceId | (inherited from PosCommon ) |
|
DevicePath | Gets or sets the hardware path of a device. (inherited from PosCommon) |
|
HardwareId | (inherited from PosCommon ) |
|
IsExclusiveUseDevice | Overridden. Gets a Boolean value that indicates whether the RemoteOrderDisplay is an exclusive-use device. |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "Aa460868.pubmethod(en-US,WinEmbedded.11).gif") |
CheckHealth | (inherited from PosCommon ) |
|
Claim | (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 | Clears the display area for the video unit(s) specified by the units parameter. |
|
ClearVideoRegion | Clears the specified video region. |
|
Close | Releases the device and its resources. (inherited from PosCommon) |
|
CompareFirmwareVersion | (inherited from PosCommon ) |
|
ControlClock | Performs the clock command requested in clockFunction on the specified video unit(s). |
|
ControlCursor | Enables or disables the cursor for the specified video unit(s). |
|
CopyVideoRegion | Copies a region of the display area to a new location on the display area for the specified video unit(s). |
|
DirectIO | (inherited from PosCommon ) |
|
DisplayData | 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 | Draws a box on the specified video unit(s). |
|
Equals | Overloaded. (inherited from Object ) |
|
FreeVideoRegion | Frees any buffer memory allocated for the specified video unit(s). |
|
GetHashCode | (inherited from Object ) |
|
GetType | (inherited from Object ) |
|
Open | Opens a device for later input/output processing. (inherited from PosCommon) |
|
ReferenceEquals | (inherited from Object ) |
|
Release | Releases exclusive access to the device. (inherited from PosCommon) |
|
ResetStatistic | (inherited from PosCommon ) |
|
ResetStatistics | Overloaded. (inherited from PosCommon ) |
|
ResetVideo | Sets the specified video unit(s) to a turned on state. |
|
RestoreVideoRegion | Restores a previously saved video region of the display area from the requested bufferId for the specified video unit(s). |
|
RetrieveStatistic | (inherited from PosCommon ) |
|
RetrieveStatistics | Overloaded. (inherited from PosCommon ) |
|
SaveVideoRegion | Saves the specified video region of the display area to one of the provided video buffers for the specified video unit(s). |
|
SelectCharacterSet | Selects a compatible character set for the specified video unit(s). |
|
SetCursor | Updates the cursor position on the specified video unit(s). |
|
ToString | (inherited from Object ) |
|
TransactionDisplay | Enters or exits transaction mode for the specified video unit(s). |
|
UpdateFirmware | (inherited from PosCommon ) |
|
UpdateStatistic | (inherited from PosCommon ) |
|
UpdateStatistics | Overloaded. (inherited from PosCommon ) |
|
UpdateVideoRegionAttribute | Modifies the attribute on the specified video unit(s). |
|
VideoSound | Sounds the video enunciator for the specified units. |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "Aa460868.protmethod(en-US,WinEmbedded.11).gif") |
DeleteConfigurationProperty | (inherited from PosCommon ) |
|
Finalize | (inherited from Object ) |
|
GetConfigurationProperty | (inherited from PosCommon ) |
|
Invoke | (inherited from PosCommon ) |
|
MemberwiseClone | (inherited from Object ) |
|
SetConfigurationProperty | (inherited from PosCommon ) |
Top
Public Events
(see also Protected Events )
| Name | Description | |
|---|---|---|
.gif "Aa460868.pubevent(en-US,WinEmbedded.11).gif") |
DataEvent | Notifies the application when input data from a video touch unit is available. |
|
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) |
Top
Protected Events
| Name | Description | |
|---|---|---|
.gif "Aa460868.protevent(en-US,WinEmbedded.11).gif") |
DeviceAddedEvent | (inherited from PosCommon ) |
|
DeviceRemovedEvent | (inherited from PosCommon ) |
Top