Share via

RemoteOrderDisplay.DrawBox Method

  • Article

2/27/2008

Draws a box on the specified video unit(s).

Namespace: Microsoft.PointOfService
Assembly: Microsoft.PointOfService (in microsoft.pointofservice.dll)

Syntax

'Declaration
Public MustOverride Sub DrawBox ( _
    units As DeviceUnits, _
    row As Integer, _
    column As Integer, _
    height As Integer, _
    width As Integer, _
    attribute As VideoAttributes, _
    borderType As BorderType _
)

public abstract void DrawBox (
    DeviceUnits units,
    int row,
    int column,
    int height,
    int width,
    VideoAttributes attribute,
    BorderType borderType
)

public:
virtual void DrawBox (
    DeviceUnits units, 
    int row, 
    int column, 
    int height, 
    int width, 
    VideoAttributes attribute, 
    BorderType borderType
) abstract

public abstract void DrawBox (
    DeviceUnits units, 
    int row, 
    int column, 
    int height, 
    int width, 
    VideoAttributes attribute, 
    BorderType borderType
)

public abstract function DrawBox (
    units : DeviceUnits, 
    row : int, 
    column : int, 
    height : int, 
    width : int, 
    attribute : VideoAttributes, 
    borderType : BorderType
)

Parameters

  • units
    The units to operate on.
  • row
    The box's start row.
  • column
    The box's start column.
  • height
    The number of rows in the box.
  • width
    The number of columns in the box.
  • attribute
    The video attribute.
  • borderType
    The border type.

Remarks

The remote order display tries to draw a box that uses the border type specified. If the character set does not support the chosen border type, the service object chooses the best fit from the given character set.

DrawBox is performed synchronously if AsyncMode is false, and asynchronously if AsyncMode is true.

DrawBox may cause a PosControlException exception to be thrown with the following ErrorCode:

Value

Description

Failure

An error occurred while communicating with one of the video units specified by units. The ErrorUnits and ErrorString properties are updated before return.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.

See Also

Reference

RemoteOrderDisplay Class
RemoteOrderDisplay Members
Microsoft.PointOfService Namespace
AsyncMode
ErrorString
ErrorUnits