Interface IParseRecordEvent

Parse record event information.

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

Parse record event information. See ParseRecord(IParseRecordEvent)

Properties

RecordRegion

Gets the rectangular region which describes the contents of the record.

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

The contents of the record.
Remarks

Note that this region will always have an offset of zero since it does not necessarily represent a contiguous region on the screen. In fact when a record is split across screens, a portion of the region will not be on the current screen.

Methods

CreateFieldLocation(int, int)

Creates a field location using linear coordinates.

Declaration
IFieldLocation CreateFieldLocation(int offset, int length)
Parameters
Type Name Description
int offset

The zero-based offset from the start of the record
int length

The length of the field.
Returns
Type Description
IFieldLocation

A IFieldLocation object describing the field's location.
Exceptions
Type Condition
ApptrieveException

Thrown if the offset or length is invalid.

DefaultParseRecord()

Gets the default field locations as defined by the model.

Declaration
IDictionary<string, IFieldLocation> DefaultParseRecord()
Returns
Type Description
IDictionary<string, IFieldLocation>

A dictionary of field names to IFieldLocation objects.
Remarks

Gets the default field locations as defined by the model. The contents of the returned map can be modified and used as the event's return value.