LineDisplay.CreateWindow Method (POS for .NET v1.14 SDK Documentation)

3/2/2014

Creates a viewport over the part of the display specified by the first four parameters.

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

Syntax

'Declaration
Public MustOverride Sub CreateWindow ( _
    viewportRow As Integer, _
    viewportColumn As Integer, _
    viewportHeight As Integer, _
    viewportWidth As Integer, _
    windowHeight As Integer, _
    windowWidth As Integer _
)

public abstract void CreateWindow (
    int viewportRow,
    int viewportColumn,
    int viewportHeight,
    int viewportWidth,
    int windowHeight,
    int windowWidth
)

public:
virtual void CreateWindow (
    int viewportRow, 
    int viewportColumn, 
    int viewportHeight, 
    int viewportWidth, 
    int windowHeight, 
    int windowWidth
) abstract

public abstract void CreateWindow (
    int viewportRow, 
    int viewportColumn, 
    int viewportHeight, 
    int viewportWidth, 
    int windowHeight, 
    int windowWidth
)

public abstract function CreateWindow (
    viewportRow : int, 
    viewportColumn : int, 
    viewportHeight : int, 
    viewportWidth : int, 
    windowHeight : int, 
    windowWidth : int
)

Parameters

• viewportRow
  The viewport’s start device row.

• viewportColumn
  The viewport’s start device column.

• viewportHeight
  The number of device rows in the viewport.

• viewportWidth
  The number of device columns in the viewport.

• windowHeight
  The number of rows in the window.

• windowWidth
  The number of columns in the window.

Remarks

The window size is specified by the last two parameters. Valid window row values range from (0) to (windowHeight-1) and column values range from (0) to (windowWidth-1).

The window size must be at least as large as the viewport size.

The window size can be larger than the viewport size in one direction. By using the window marquee properties MarqueeType, MarqueeFormat, MarqueeUnitWait, and MarqueeRepeatWait, such a window can be continuously scrolled as a marquee.

When successful, CreateWindow sets the CurrentWindow property to the window number assigned to this window. The following table shows the properties that are maintained for each window and with what value they are initialized.

Property	Value
Rows	windowHeight
Columns	windowWidth
CursorRow	0
CursorColumn	0
CursorUpdate	true
MarqueeType	None
MarqueeFormat	Walk
MarqueeUnitWait	0
MarqueeRepeatWait	0
InterCharacterWait	0

CreateWindow may cause a PosControlException to be thrown with the following ErrorCode.

Value	Meaning
Illegal	One of the following conditions has occurred: CreateWindow cannot be called for Window 0. One or more parameters are out of their valid ranges. All available windows are already that is used.

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

LineDisplay Class
LineDisplay Members
Microsoft.PointOfService Namespace
DestroyWindow
CurrentWindow