Share via

LineDisplayBase.DisplayTextAt Method (Int32, Int32, String, DisplayTextMode) (POS for .NET v1.14 SDK Documentation)

  • Article

3/2/2014

Displays the string of characters at the specified row and column, in the specified display mode.

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

Syntax

'Declaration
Public Overrides Sub DisplayTextAt ( _
    row As Integer, _
    column As Integer, _
    data As String, _
    attribute As DisplayTextMode _
)

public override void DisplayTextAt (
    int row,
    int column,
    string data,
    DisplayTextMode attribute
)

public:
virtual void DisplayTextAt (
    int row, 
    int column, 
    String^ data, 
    DisplayTextMode attribute
) override

public void DisplayTextAt (
    int row, 
    int column, 
    String data, 
    DisplayTextMode attribute
)

public override function DisplayTextAt (
    row : int, 
    column : int, 
    data : String, 
    attribute : DisplayTextMode
)

Parameters

  • row
    The start row for the text.
  • column
    The start column for the text.
  • data
    The string of characters to display.
  • attribute
    The display attribute for the text. Possible values are defined by the DisplayTextMode enumeration. Must be either DisplayTextMode.Normal or DisplayTextMode.Blink.

Remarks

The characters in data are processed beginning at the window location specified by the row and column parameters, and continuing in succeeding columns.

If the CapBlink property is set to NoBlink, all blink escape sequences will be filtered out for purposes of display. If the CapReverse property is set to None, all reverse escape sequences will be filtered out.

DisplayTextAt has the same effect as setting the CursorRow property to row, setting the CursorColumn property to column, and then calling the DisplayText method.

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

DisplayTextAt may throw a PosControlException with the following ErrorCodes:

Value

Meaning

Illegal

One or more of the following conditions has occurred:The value specified for row or for column is out of range; The value specified for attribute isn’t found in the DisplayTextMode enumeration; or DisplayText can’t be called when the device is in Marquee On Mode.

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.DisplayTextAt Method
DisplayTextMode Enumeration