Share via


RemoteOrderDisplay.DrawBox Method

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

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

Usage

'Usage
Dim units As DeviceUnits
Dim row As Integer
Dim column As Integer
Dim height As Integer
Dim width As Integer
Dim attribute As VideoAttributes
Dim borderType As BorderType
Dim remoteOrderDisplay1 As RemoteOrderDisplay
remoteOrderDisplay1.DrawBox(units, row, column, height, width, attribute, borderType)

Syntax

'Declaration
Public MustOverride Sub DrawBox( _
    ByVal units As DeviceUnits, _
    ByVal row As Integer, _
    ByVal column As Integer, _
    ByVal height As Integer, _
    ByVal width As Integer, _
    ByVal attribute As VideoAttributes, _
    ByVal borderType As BorderType _
)
public abstract void DrawBox(
    DeviceUnits units,
    int row,
    int column,
    int height,
    int width,
    VideoAttributes attribute,
    BorderType borderType
);
public: abstract Void DrawBox(
    DeviceUnits^ units,
    Int32 row,
    Int32 column,
    Int32 height,
    Int32 width,
    VideoAttributes^ attribute,
    BorderType^ borderType
);
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
) : Void;

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 will attempt to draw a box with 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 returns void if successful, and can throw the following exception:

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.

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows Longhorn, and Windows 2000

Target Platforms

See Also

Reference

RemoteOrderDisplay Class
RemoteOrderDisplay Members
Microsoft.PointOfService Namespace
AsyncMode
ErrorString
ErrorUnits