Interface IEntityMoveCursorEvent

Entity move cursor event information.

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

Entity move cursor event information. See MoveCursor(IEntityMoveCursorEvent)

Properties

EventCursorPosition

Gets the cursor position when the event fired.

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

The cursor position.
Remarks

Gets the cursor position when the event fired. If the cursor position changes during the course if this event, it will not be reflected in the value returned.

TargetCursorPosition

Gets the target cursor position.

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

The target cursor position.

Methods

DefaultMoveCursor()

Moves the cursor using the default algorithm.

Declaration
void DefaultMoveCursor()
Remarks

For character mode hosts this means one of two methods will be used. The method selected depends on the presence of a move cursor forward event handler or command list.

If a move cursor forward event handler is defined or a move cursor forward command list is defined, VHI will iteratively use this event handler or command list to move the cursor until it reaches the desired location. If tab stops are defined on the entity, the request to move the cursor will fail immediately if the location is not at a tab stop. If the cursor returns to the starting location before stopping at the requested location, the cursor movement also fails.

If a method to move the cursor forward is not defined, VHI will use the arrow keys to move the cursor. VHI will calculate how far vertically and horizontally the cursor needs to move and issue the appropriate number of arrow keys in each direction.

If the selected method of cursor movement fails to position the cursor at the requested location, an ApptrieveException will be thrown.

Exceptions
Type Condition
ApptrieveException

Thrown if the move cursor fails.