Class WaitForDisplayString

A class that represents a VHI WaitForDisplayString command.

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

Constructors

WaitForDisplayString(string, int, int, int, bool)

Constructs a new WaitForDisplayString command

Declaration
public WaitForDisplayString(string text, int timeout, int row, int column, bool relativeToCursor)
Parameters
Type Name Description
string text

the text to wait to appear
int timeout

the timeout in seconds
int row

if relativeToCursor is true, the offset to the cursor row; otherwise, the one-based screen row (ANY_ROW matches any row)
int column

if relativeToCursor is true, the offset to the cursor column; otherwise, the one-based screen column (ANY_COLUMN matches any column)
bool relativeToCursor

true if the row and column should be interpreted as offsets from the cursor position
See Also

Properties

Column

Gets the column.

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

if RelativeToCursor is true, the offset to the cursor column; otherwise, the one-based screen column (ANY_COLUMN matches any column)
See Also

Name

Gets the command name.

Declaration
public override string Name { get; }
Property Value
Type Description
string

the command name
Overrides
See Also

RelativeToCursor

Gets the relative to cursor flag.

Declaration
public virtual bool RelativeToCursor { get; }
Property Value
Type Description
bool

true if the Row and Column should be interpreted as offsets from the cursor position
See Also

Row

Gets the row.

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

if RelativeToCursor is true, the offset to the cursor row; otherwise, the one-based screen row (ANY_ROW matches any row)
See Also

Text

Gets the text to wait to appear.

Declaration
public virtual string Text { get; }
Property Value
Type Description
string

the text to wait to appear
See Also

Timeout

Gets the wait timeout.

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

the timeout in seconds
See Also

See Also