Class CursorPosition

An immutable class that represents a cursor position on a screen.

Inheritance
object
CursorPosition
Inherited Members
Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI
Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll
Syntax
[Serializable]
public class CursorPosition

Constructors

CursorPosition(int, int, int)

Constructs a CursorPosition object from an offset and screen height and width.

Declaration
public CursorPosition(int offset, int screenHeight, int screenWidth)
Parameters
Type Name Description
int offset

Linear offset.
int screenHeight

Screen height.
int screenWidth

Screen width.

Properties

Column

Gets the one-based cursor column.

Declaration
public virtual int Column { get; }
Property Value
Type Description
int

The cursor column

Offset

Gets the zero-based linear offset of the cursor.

Declaration
public virtual int Offset { get; }
Property Value
Type Description
int

Linear offset

Row

Gets the one-based cursor row.

Declaration
public virtual int Row { get; }
Property Value
Type Description
int

The cursor row

ScreenHeight

Gets the screen height in rows.

Declaration
public virtual int ScreenHeight { get; }
Property Value
Type Description
int

The screen height

ScreenWidth

Gets the screen width in columns.

Declaration
public virtual int ScreenWidth { get; }
Property Value
Type Description
int

The screen width

Methods

Equals(object)

Compares one cursor position to another.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj

The cursor position object for comparison.
Returns
Type Description
bool

True if the cursor position is the same, otherwise false.
Overrides
Remarks

Compares one cursor position to another. A cursor position is considered equal if the linear offset, screen height and screen width are all equal.

GetHashCode()

Compute a hash code for this CursorPosition

Declaration
public override int GetHashCode()
Returns
Type Description
int

hash code for the CursorPosition.
Overrides

ToString()

Returns a string that represents the CursorPosition.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents the CursorPosition.
Overrides