Class WaitForUpdate

A class that represents a VHI WaitForUpdate command.

Inheritance

object

Command

WaitForUpdate

Inherited Members

Command.isValidEchoType(int)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI.Command

Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll

Syntax

[Serializable]
public class WaitForUpdate : Command

Constructors

WaitForUpdate(int, int, int, int, RegionType, bool, int)

Constructs a new WaitForUpdate command.

Declaration

public WaitForUpdate(int topRow, int leftColumn, int bottomRow, int rightColumn, RegionType regionType, bool relativeToCursor, int timeout)

Parameters

Type	Name	Description
int	topRow	the top row of the region to watch
int	leftColumn	the left column of the region to watch
int	bottomRow	the bottom row of the region to watch
int	rightColumn	the right column of the region to watch
RegionType	regionType	the type of region to use: LINEAR_REGION or RECTANGULAR_REGION.
bool	relativeToCursor	true if the region is relative to the cursor position
int	timeout	the maximum time to wait in seconds

See Also

ExecuteCommandList(IList<Command>)

WaitForUpdate(int, int, int, int, RegionType, bool, int)

Properties

BottomRow

Gets the bottom row of the region.

Declaration

public virtual int BottomRow { get; }

Property Value

Type	Description
int	the bottom row of the region to watch

See Also

ExecuteCommandList(IList<Command>)

WaitForUpdate(int, int, int, int, RegionType, bool, int)

LeftColumn

Gets the left column of the region.

Declaration

public virtual int LeftColumn { get; }

Property Value

Type	Description
int	the left column of the region to watch

See Also

ExecuteCommandList(IList<Command>)

WaitForUpdate(int, int, int, int, RegionType, bool, int)

Name

Gets the command name.

Declaration

public override string Name { get; }

Property Value

Type	Description
string	the command name

Overrides

Command.Name

See Also

ExecuteCommandList(IList<Command>)

WaitForUpdate(int, int, int, int, RegionType, bool, int)

RegionType

Gets the region type.

Declaration

public virtual RegionType RegionType { get; }

Property Value

Type	Description
RegionType	the type of region to use: LINEAR_REGION or RECTANGULAR_REGION.

See Also

ExecuteCommandList(IList<Command>)

WaitForUpdate(int, int, int, int, RegionType, bool, int)

RelativeToCursor

Gets the relative to cursor flag.

Declaration

public virtual bool RelativeToCursor { get; }

Property Value

Type	Description
bool	true if the region is relative to the cursor position

See Also

ExecuteCommandList(IList<Command>)

WaitForUpdate(int, int, int, int, RegionType, bool, int)

RightColumn

Gets the right column of the region.

Declaration

public virtual int RightColumn { get; }

Property Value

Type	Description
int	the right column of the region to watch

See Also

ExecuteCommandList(IList<Command>)

WaitForUpdate(int, int, int, int, RegionType, bool, int)

Timeout

Gets the timeout.

Declaration

public virtual int Timeout { get; }

Property Value

Type	Description
int	the maximum time to wait in seconds

See Also

ExecuteCommandList(IList<Command>)

WaitForUpdate(int, int, int, int, RegionType, bool, int)

TopRow

Gets the top row of the region.

Declaration

public virtual int TopRow { get; }

Property Value

Type	Description
int	the top row of the region to watch

See Also

ExecuteCommandList(IList<Command>)

WaitForUpdate(int, int, int, int, RegionType, bool, int)

See Also

ExecuteCommandList(IList<Command>)

WaitForUpdate(int, int, int, int, RegionType, bool, int)