ActiveView

Description

ActiveView extends the capabilities of the ActiveUTS and ActiveT27 controls by providing a set of collections that map host screens to predefined sets of fields and attributes. The container program can create an instance of the ActiveX control, as normal, and then use the ActiveViewMgr property to access the collections.  The collections may be used to identify screens at runtime and then to access field data.

ActiveViewMgr Object API

The ActiveViewMgr API provides the program containing the ActiveX control with ability to manipulate the various collections.  The major collections are as follows:

• ScreenMaps collection
• Users collection
• Hosts collection

Each ScreenMap collection maintains two secondary collections:

• Identifiers collection
• Fields collection

Obtain a handle to the ActiveViewMgr object from an instance of the ActiveUTS/T27 control by using the ActiveViewMgr property, for example in Visual Basic:

Set viewMgr = ActiveUTS1.ActiveViewMgr

Then you can access any of the properties and methods described below, for example:

Set screenMaps = viewMgr.ScreenMaps
screenMapCount = screenMaps.Count
Set screenMapLogon = screenMaps.Item(2)

 

ActiveViewMgr Properties

Property Name	Description	Type
ScreenMaps	Returns a handle to the ScreenMaps collection.	IDispatch*
Users	Returns a handle to the Users collection.	IDispatch*
Hosts	Returns a handle to the Hosts collection.	IDispatch*

ActiveViewMgr Methods

Method	Description	Return
Load(BSTR settingsFileName)	Open a settings file that defines all the collections (typically created by programmatically building up the collections and using Save).	long
Save(BSTR settingsFileName)	Save settings  If settingsFileName is blank, the file name supplied to Load is used.	long

 

ScreenMaps Properties (collection)

Property Name	Description	Type
Count	Returns the count of screen maps	long
DefaultScreenMap	Returns a handle to the default screen map.	IDispatch*

ScreenMaps Methods

Property Name	Description	Type
Add	Add a new screen map to the collection	IDispatch*
GetCurrentScreenMap	Returns a handle to the current screen map, which was set in the call to MatchScreen.	short
Item(long index)	Returns a handle the requested screen map number (the first is index 0)	IDispatch*
MatchScreen(boolean  useDefaultIfNoMatch)	Matches the current terminal screen contents to the identifiers of all defined screen maps, in the order in which they were defined.  Returns true if a match was found.  If useDefaultIfNoMatch is true then the Default screen is set as the current screen map (the return is still false).	boolean
Remove(long index)	Delete the requested item at index.	long

 

ScreenMap Properties

Property Name	Description	Type
Action	Get/set the action property which is typically used by an ASP page after using the MatchScreen method to invoke the appropriate action. 0 = None 1 = Generate Page 2 = Insert Form 3 = Map Fields 4 = Call Script	boolean
Fields	Returns a handle to the Fields collection.	IDispatch*
Identifiers	Returns a handle to the Identifiers collection.	IDispatch*
Monospace	The monospace property which is used to indicate that the web page should use a monospaced font and text overwrite mode.	boolean
Name	Get/set the screen map name.	BSTR*
PageName	The web page name.  This is typically used as a template web page by the web page generation ASP.	BSTR*
ScriptName	The script name. This is the name of an ASP page that is used when the action is Call Script.	BSTR*

ScreenMap Methods

Property Name	Description	Type
CreateMapFromScreen	Creates a full screen map from all the fields on the terminal screen.	long
GetFieldsFromScreen	Used at run time to transfer screen fields data to the screen map fields.	long
PutFieldsToScreen	Used at run time to put the screen map fields to the terminal screen.	long

 

Fields Properties (collection)

Property Name	Description	Type
Count	Returns the count of fields	long

Fields Methods

Property Name	Description	Type
Add(long index)	Add a new field to the collection	IDispatch*
Item(long index)	Returns a handle the requested field number (the first is index 0)	IDispatch*
Remove(long index)	Delete the requested item at index.	long

 

Field Properties

Property Name	Description	Type
Column	Field start column	long
GetFrom	Web page field name to retrieve field data from when parsing an input web page form (leave blank if not to be retrieved).	BSTR*
Length	Length of field	long
LineBreak	If true a line break is required after this field when generating the web page.	boolean
Name	Field name	BSTR*
Numeric	If true the generated web page field should only accept numeric characters.	boolean
PutTo	Web page field name to output field data when generating web page (leave blank if not to be output).	BSTR*
RightJustify	If true the generated web page field should be right justified entry.	boolean
Row	Field start row	long
Text	The field text	BSTR*
Type	Field type 0 = input field 1 = static text	long

Field Methods

No methods defined.

 

Identifiers Properties (collection)

Property Name	Description	Type
Count	Returns the count of Identifiers	long

Identifiers Methods

Method Name	Description	Type
Add(long index)	Add a new identifier to the collection	IDispatch*
Item(long index)	Returns a handle the requested identifier number (the first is index 0)	IDispatch*
Remove(long index)	Delete the requested item at index.	long

 

Identifier Properties

Property Name	Description	Type
Column	Identifier start column	long
Condition	Match condition: IDENT_CONDITION_EQUAL IDENT_CONDITION_NOT_EQUAL IDENT_CONDITION_CONTAINS IDENT_CONDITION_NOT_CONTAINS When the ScreenMaps.MatchScreen method is called, the text in Identifier.Text is compared with the screen text at Identifier.Row and Identifier.Column to see if it matches based up on the condition setting.	long
Length	Length of Identifier	long
Name	Identifier name	BSTR*
Row	Identifier start row	long
Text	The Identifier text	BSTR*

Identifier Methods

No methods defined.

 

Users Properties (collection)

Property Name	Description	Type
Count	Returns the count of users	long

Users Methods

Property Name	Description	Type
Add(long index)	Add a new user to the collection	IDispatch*
Item(long index)	Returns a handle the requested user number (the first is index 0)	IDispatch*
Remove(long index)	Delete the requested item at index.	long

 

User Properties

Property Name	Description	Type
Description	Description of user	BSTR*
InitialHost	The host name to connect to.	BSTR*
Level	Authority level (user, admin)	long
Name	The user name	BSTR*
TerminalName	Terminal name to use when connecting to the host	BSTR*

User Methods

No methods defined.

 

Hosts Properties (collection)

Property Name	Description	Type
Count	Returns the count of hosts	long

Hosts Methods

Property Name	Description	Type
Add(long index)	Add a new host to the collection	IDispatch*
Item(long index)	Returns a handle the requested host number (the first is index 0)	IDispatch*
Remove(long index)	Delete the requested item at index.	long

 

Host Properties

Property Name	Description	Type
Definition	The host definition string	long
Host name	The host name	BSTR*

Host Methods

No methods defined.