Share via

LineDisplayBase.ClearText Method (POS for .NET v1.12 SDK Documentation)

  • Article

2/27/2008

Clears the current window by displaying blanks, sets the CursorRow and CursorColumn properties to zero, and then resynchronizes the beginning of the window with the start of the viewport.

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

Syntax

'Declaration
Public Overrides Sub ClearText

public override void ClearText ()

public:
virtual void ClearText () override

public void ClearText ()

public override function ClearText ()

Remarks

The LineDisplayBase class implementation of ClearText verifies that the line display device is opened, claimed, and enabled. If the device is in Immediate mode or Teletype mode, the viewport is also cleared immediately.

If in Marquee On mode, ClearText is illegal.

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

Value

Meaning

Illegal

The device is in Marquee On mode and can’t be cleared.

Otherwise, it clears the window. If the device is in Marquee Init Mode, LineDisplayBase refreshes the window, using current property values.

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