Share via

LineDisplay.DisplayTextAt Method (Int32, Int32, String, DisplayTextMode)

  • Article

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

Usage

'Usage
Dim row As Integer
Dim column As Integer
Dim data As String
Dim attribute As DisplayTextMode
Dim lineDisplay1 As LineDisplay
lineDisplay1.DisplayTextAt(row, column, data, attribute)

Syntax

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

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

public: abstract Void DisplayTextAt(
    Int32 row,
    Int32 column,
    String^ data,
    DisplayTextMode^ attribute
);

public abstract void DisplayTextAt(
    int row,
    int column,
    System.String data,
    DisplayTextMode attribute
);

public abstract function DisplayTextAt(
     row : int,
     column : int,
     data : String,
     attribute : DisplayTextMode
) : Void;

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 DisplayBlink.NoBlink, all blink escape sequences will be filtered out for purposes of display. If the CapReverse property is set to DisplayReverse.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.

Before calling this method, the application must open, claim, and enable the device.

DisplayTextAt returns void if successful, and it can throw the following exceptions:

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 enumerator; or

The window is in Marquee On Mode, and DisplayTextAt can’t be called while the device is in that 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.

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows Longhorn, and Windows 2000

Target Platforms

See Also

Reference

LineDisplay Class
LineDisplay Members
Microsoft.PointOfService Namespace
DisplayText
DisplayText
ClearText
InterCharacterWait