Share via

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

  • Article

3/2/2014

Scrolls text in the current window, in the specified direction.

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

Syntax

'Declaration
Public Overrides Sub ScrollText ( _
    direction As DisplayScrollText, _
    units As Integer _
)

public override void ScrollText (
    DisplayScrollText direction,
    int units
)

public:
virtual void ScrollText (
    DisplayScrollText direction, 
    int units
) override

public void ScrollText (
    DisplayScrollText direction, 
    int units
)

public override function ScrollText (
    direction : DisplayScrollText, 
    units : int
)

Parameters

  • direction
    Indicates the scrolling direction, as defined by the DisplayScrollText enumeration.
  • units
    Indicates the number of columns or rows to scroll.

Remarks

ScrollText is legal only when the window is in Immediate mode.

If the window size for the scroll direction matches its viewport size, then the window data is scrolled, the last units rows or columns are set to spaces, and the viewport is updated.

If the window size for the scroll direction is larger than its viewport, then the window data is not changed. Instead, the mapping of the window into the viewport is moved in the specified direction. The window data is not altered, but the viewport is updated. If scrolling by units would go beyond the beginning of the window data, then the window is scrolled so that the first viewport row or column contains the first window row or column. If scrolling by units would go beyond the end of the window data, then the window is scrolled so that the last viewport row or column contains the last window row or column.

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

ScrollText may throw a PosControlException with the following ErrorCodes:

Value

Meaning

Illegal

The window isn’t in Immediate Mode—that is, the MarqueeType property must be set to None and the InterCharacterWait property must be set to 0 (zero).

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.ScrollText Method