Share via

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

  • Article

3/2/2014

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

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

Syntax

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

public override 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
) override

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

public override 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. Using the window marquee properties MarqueeType, MarqueeFormat, MarqueeUnitWait, and MarqueeRepeatWait, such a window can be continuously scrolled in a marquee fashion.

When successful, CreateWindow sets the CurrentWindow property to the window number assigned to this window. The following properties are maintained for each window, and are initialized as given:

Property

Value

Rows

windowHeight

Columns

windowWidth

CursorRow

0

CursorColumn

0

CursorUpdate

true

MarqueeType

None

MarqueeFormat

Walk

MarqueeUnitWait

0

MarqueeRepeatWait

0

InterCharacterWait

0

The LineDisplayBase class ensures that the line display device has been opened, claimed, and enabled.

CreateWindow may throw a PosControlException with the following ErrorCodes:

Value

Meaning

Illegal

One of the following conditions has occurred:CreateWindow can’t be called for Window 0;One or more parameters are out of their valid ranges; or All available windows are already in use.

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

LineDisplayBase Class
LineDisplayBase Members
Microsoft.PointOfService.BaseServiceObjects Namespace
LineDisplay.CreateWindow Method