Interface IEntityDepartureEvent

Entity departure event information.

Inherited Members
Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI
Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll
Syntax
public interface IEntityDepartureEvent : IEntityEvent, IModelEvent, IEvent
Remarks

Entity departure event information. See EntityDeparture(IEntityDepartureEvent)

Properties

CursorPosition

Gets the cursor position on the terminal screen.

Declaration
CursorPosition CursorPosition { get; }
Property Value
Type Description
CursorPosition

The current cursor position.
Exceptions
Type Condition
ApptrieveException

Thrown if there is no current cursor position. This could occur if entity departure resulted from a dropped host connection.

NextEntity

Gets the name of the newly recognized entity.

Declaration
string NextEntity { get; }
Property Value
Type Description
string

The name of the newly recognized entity or an empty string if none.

TerminalScreen

Gets the size and contents of the terminal screen.

Declaration
IRectangularTerminalRegion TerminalScreen { get; }
Property Value
Type Description
IRectangularTerminalRegion

The contents of the entire terminal screen.
Exceptions
Type Condition
ApptrieveException

Thrown if there is no current terminal screen. This could occur if entity departure resulted from a dropped host connection.

Methods

OverrideDeparture()

Overrides the departure and remains on the current entity.

Declaration
void OverrideDeparture()
Remarks

Overrides the departure and remains on the current entity. This can only be called if a new entity is not recognized ({@link #getNextEntity} returns an empty string).

Exceptions
Type Condition
ApptrieveException

Thrown if the next next entity has already been recognized.