Interface IReadFieldEvent

Read field event information.

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

Read field event information. See ReadField(IReadFieldEvent)

Properties

TerminalRegion

Gets the screen region that describes the location, size and contents of the field at the time the event fired.

Declaration
ITerminalRegion TerminalRegion { get; }
Property Value
Type Description
ITerminalRegion

The location and contents of the field.
Remarks

Gets the screen region that describes the location, size and contents of the field at the time the event fired. The object returned can be cast to either ILinearTerminalRegion or IRectangularTerminalRegion depending on the type of region.
If the location, size or contents of the field changes during the course of this event, it will not be reflected in the value returned.

Methods

DefaultReadField()

Gets the value read from the field at the time the event fired.

Declaration
string DefaultReadField()
Returns
Type Description
string

The value of the field as if the read event was not scripted.
Remarks

If the value of the field changes during the course of this event, it will not be reflected in the value returned. Symbols and spaces will have been removed from the value if the field is configured to do so in the model.