Interface IParseScreenEvent

Parse screen event information.

Inherited Members

IRecordSetEvent.RecordSetName

IRecordSetEvent.PageNumber

IRecordSetEvent.RecordSetContext

IRecordSetEvent.RecordSetMetaData

IEntityEvent.EntityName

IEntityEvent.TabStops

IHostSessionEvent.HostSession

IModelEvent.CurrentOperation

IModelEvent.CurrentProcedure

IModelEvent.ModelContext

IModelEvent.ClientSession

IEvent.Logger

IEvent.CheckForTimeout()

IEvent.EventStack

IEvent.GetHandlerProperty(string)

IEvent.IsDesignEnvironment()

IEvent.CreateUserErrorMessage(string)

IEvent.CreateErrorMessage(int)

IEvent.CreateErrorMessage(int, object[])

Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI

Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll

Syntax

public interface IParseScreenEvent : IRecordSetEvent, IEntityEvent, IHostSessionEvent, IModelEvent, IEvent

Remarks

Parse screen event information. See ParseScreen(IParseScreenEvent)

Properties

RecordSetRegion

Gets the rectangular screen region which describes the location, size and contents of the recordset.

Declaration

IRectangularTerminalRegion RecordSetRegion { get; }

Property Value

Type	Description
IRectangularTerminalRegion	The location, size and contents of the recordset.

Methods

CreateRecordLocation(int, int, bool)

Creates a record location given a row and height.

Declaration

IRecordLocation CreateRecordLocation(int firstRow, int height, bool whole)

Parameters

Type	Name	Description
int	firstRow	The one-based first row measured from the top of the record set (not the top of the screen)
int	height	The number or rows in the record.
bool	whole	True if the record is whole, otherwise false.

Returns

Type	Description
IRecordLocation	a Attachmate.Verastream.HostIntegrator.ScriptAPI.RecordLocation object describing the record's location.

Remarks

Creates a record location given a row and height. This method assumes the record spans the width of the record set.

Exceptions

Type	Condition
ApptrieveException	If the row or height is invalid

CreateRecordLocation(int, int, int, int, bool)

Creates a record location given a rectangular region.

Declaration

IRecordLocation CreateRecordLocation(int left, int top, int width, int height, bool whole)

Parameters

Type	Name	Description
int	left	The one-based horizontal offset from the left side of the record set (not the column on the screen)
int	top	The one-based vertical offset from the top of the record set (not the row on the screen).
int	width	The number of rows in the record.
int	height	The number of columns in the record.
bool	whole	True if the record is whole, otherwise false.

Returns

Type	Description
IRecordLocation	A IRecordLocationobject describing the record location.

Exceptions

Type	Condition
ApptrieveException	If the row or height is invalid.

DefaultParseScreen()

Gets the default record locations as defined in the model.

Declaration

IList<IRecordLocation> DefaultParseScreen()

Returns

Type	Description
IList<IRecordLocation>	A list of IRecordLocation} objects.

Remarks

Gets the default record locations as defined in the model. The contents of the returned list can be modified and used as the event's return value.