Interface Screen

Provides access to the contents of the host screen's presentation space.

Namespace: Attachmate.Verastream.HostIntegrator.E2V

Assembly: Attachmate.Verastream.HostIntegrator.E2V.dll

Syntax

[ComVisible(true)]
public interface Screen

Properties

Application

Returns the System object. Read-only.

Declaration

System Application { get; }

Property Value

Type	Description
System

Col

Get the 1-based cursor column. Move the cursor to the specified column.

Declaration

short Col { get; set; }

Property Value

Type	Description
short

Cols

The number of columns in the current screen.

Declaration

short Cols { get; }

Property Value

Type	Description
short

InHiddenField

Returns true if the cursor is within a hidden (password) field, otherwise false.

Declaration

bool InHiddenField { get; }

Property Value

Type	Description
bool

Name

The name of the host screen (An entity in the VHI model). If the screen is not recognized as an entity in the model, the property returns an empty string. You can move to a named screen with the NavigateTo method.

Declaration

string Name { get; }

Property Value

Type	Description
string

OIA

Return OIA object.

Declaration

ExtraOIA OIA { get; }

Property Value

Type	Description
ExtraOIA

Parent

Returns the parent of the specified object. Read-only.

Declaration

Session Parent { get; }

Property Value

Type	Description
Session

Row

Get the 1-based cursor row. Move the cursor to the specified row.

Declaration

short Row { get; set; }

Property Value

Type	Description
short

Rows

The number of rows in the current screen.

Declaration

short Rows { get; }

Property Value

Type	Description
short

Methods

Area(short, short, short, short, object, short)

Returns an Area object with the defined coordinates.

Declaration

Area Area(short Row, short Col, short EndRow, short EndCol, object Page = null, short Type = 3)

Parameters

Type	Name	Description
short	Row	The row where the selection begins.
short	Col	The column where the selection begins.
short	EndRow	The row where the selection ends.
short	EndCol	The column where the selection ends.
object	Page	VT only - ignored.
short	Type	Determines how the coordinates of the Area object (top, left, bottom, right) are interpreted when the object is selected.

Returns

Type	Description
Area	The Area object with the defined coordinates.

FieldAttribute(short, short)

Return field attribute in Extra format. The MDT bit is not available in the VHI connector and will always be zero.

Declaration

short FieldAttribute(short Row, short Col)

Parameters

Type	Name	Description
short	Row	row of the attribute to return, one-based.
short	Col	column of the attribute to return, one-based.

Returns

Type	Description
short	3270 field attribute

GetString(short, short, short, short)

Retrieve the characters on the screen.

Declaration

string GetString(short Row, short Col, short Length, short Page = -1)

Parameters

Type	Name	Description
short	Row	starting row of the characters to return, one-based.
short	Col	starting column of the characters to return, one-based.
short	Length	the number of characters to return
short	Page	The parameter Page is here for compatibility and has no effect.

Returns

Type	Description
string	the characters on the screen.

MoveTo(short, short, short)

Move cursor to position.

Declaration

void MoveTo(short Row, short Col, short Page = -1)

Parameters

Type	Name	Description
short	Row	new cursor row
short	Col	new cursor position
short	Page	The parameter Page is here for compatibility and has no effect.

PutString(string, short, short, short)

Write a string to a specified position on the screen.

Declaration

void PutString(string Text, short Row, short Col, short Page = -1)

Parameters

Type	Name	Description
string	Text	The string to write to the screen.
short	Row	The row where the string should be written.
short	Col	The column where the string should be written.
short	Page	The parameter page is here for compatibility and has no effect.

Search(string, short, short, object)

Returns an Area object with the text specified in the search.

Declaration

Area Search(string Text, short Row = -1, short Col = -1, object Page = null)

Parameters

Type	Name	Description
string	Text	The string to find.
short	Row	The row where the search begins.
short	Col	The column where the search begins.
object	Page	ignored.

Returns

Type	Description
Area	Area object with the found coordinates.

Remarks

If the optional parameters are used, Screen is searched from the specified starting position. Otherwise, the entire Screen object is searched. If Search finds the specified text, the coordinate properties (Left, Top, Right, Bottom) of the returned Area object are set to the starting and ending row and column positions of the text. The Value property of the Area object is set to the text located at those coordinates. If the Screen changes at those coordinates, the Value property of the Area changes. If Search does not find the specified text, the Area object's Value property is set to an empty string, its Type property is set to 0, and its coordinate properties are set to -1.

SendKeys(string)

Sends keystrokes to the host, including function keys. The text is parsed and keys are translated into calls to PerformAidKey. Other text and unrecognized keys translated into calls to InsertStringAtCursor. Only supports 3270 keys. Security warning: do not pass unvalidated user input to this method.

Declaration

void SendKeys(string Text)

Parameters

Type	Name	Description
string	Text	key strokes and function keys.

WaitForCursor(short, short, short, short, short, short)

Call WaitForCursor(row, col, timeout/1000), where timeout is the value set in TimeoutValue.
Block waits are not supported. Note that passing -1 for either Row or Col in Extra! does not behave as documented.

Declaration

bool WaitForCursor(short Row, short Col = -1, short EndRow = -1, short EndCol = -1, short Page = 0, short Type = 0)

Parameters

Type	Name	Description
short	Row	The row where you want the cursor to appear.
short	Col	The column where you want the cursor to appear.
short	EndRow	ignored; Block waits are not supported.
short	EndCol	ignored; Block waits are not supported.
short	Page	ignored.
short	Type	ignored.

Returns

Type	Description
bool	true if the cursor moved to the location within the indicated time, otherwise false.

WaitForString(string, short, short, short, int, int, string, short, short, short)

calls WaitForString(text, row, col, timeout/1000). Block searches are not supported.

Declaration

bool WaitForString(string Text, short Row = -1, short Col = -1, short Page = -1, int Idle = -1, int timeout = -1, string option = "", short Mode = 2, short EndRow = -1, short EndCol = -1)

Parameters

Type	Name	Description
string	Text	The text to be found on the screen.
short	Row	The row on which to search for the specified text. Use -1 to designate any row.
short	Col	The column on which to search for the specified text. Use -1 to designate any column.
short	Page	The parameter page is here for compatibility and has no effect.
int	Idle	The parameter idle is here for compatibility and has no effect.
int	timeout	Sets the how long to wait for the specified text to appear. Values are in milliseconds; VHI will use timeout/1000.
string	option	The parameter options is here for compatibility and has no effect.
short	Mode	Sets the type of area to be searched. The default, 2 sets the to search as a stream starting at the specified row and column. Other values such as 3 (block search) are not supported.
short	EndRow	The parameter endRow is here for compatibility and has no effect.
short	EndCol	The parameter endCol is here for compatibility and has no effect.

Returns

Type	Description
bool	true if the specified text appears within the indicated time, otherwise false.

WaitHostQuiet(short)

calls WaitForStableDisplay(time,timeout/1000), where timeout is the value set in TimeoutValue.

Declaration

bool WaitHostQuiet(short SettleTime = 5000)

Parameters

Type	Name	Description
short	SettleTime	First argument passed to WaitForStableDisplay. If SettleTime is not specified, a default time of 5000 (5 seconds) is assumed.

Returns

Type	Description
bool	false if a timeout occured, and true otherwise.