Launcher Control Property Descriptions

You can add an EXTRA! session to any Web page by calling the EXTRA! X-treme ActiveX control. This control is called by the launch method, and uses several properties, described below.


Method name Syntax Description
launch BOOL launch() Creates and opens the EXTRA! session specified in the launchfile property.


Property name Type Description
launchfile String Required. The filename of session to open.

This can be any of the following formats:

  • SessionName.EDP
  • DriveLetter:\DirectoryName\SessionName.EDP
  • http://ServerName/DirectoryName/SessionName.EDP
Note Scripting requires double back-slash characters in strings such as: "C:\\Accounting\\SessionName.EDP"
userid String Optional. A user ID that can access this session configuration.
password String Optional, write-only. A valid password for this session configuration.
mcsurl String Optional. The URL for the MCS server to check for the session configuration file. For example, http://server_name:port_number/mcs
embedded Boolean Optional. If true the session opens embedded in a browser window. If false) the session opens in the standard EXTRA! window.

The default setting for this property is true.

session IDispatch Read-only. This property returns a pointer to the session object. This allows programmatic access to the session object and all of its sub-objects.

A full description of the properties and methods of the session object and all of its sub-objects is available in the Help installed with the EXTRA! X-treme client application here:

install directory\Attachmate\EXTRA!\ENU\EPC_OLE.HLP

onclose String Optional. Determines what happens to the session when the Web page containing the ActiveX control closes (such as when moving to a different Web page, or closing the browser). The behavior resulting from this property depends upon whether the control is embedded or not. See the table below for details.

The onclose Property

Unless an embedded session is using the detached value for the onclose property, when the session window closes, the session disconnects.

possible onclose values: if embedded if not embedded
close The session window will close when the Web page containing the ActiveX control closes. The session window will close when the associated browser closes. The associated browser is the one that opened the Web page containing the ActiveX control.
detach The session window opens as a standalone EXTRA! window, and loses any association with the browser that initially opened it. The session window doesn't make an association with the browser that opened it, and so remains independent whether the browser is closed or not.

This is the default setting for a non-embedded session.

cached The session window will close when the Web page containing the ActiveX control closes; however, the session remains connected. The session's state is cached by the browser, allowing the user to visit other Web pages, and then return to the Web page that calls the session, without losing her place in the host application. If the user closes the browser, the session is disconnected and the state is lost.

This is the default setting for an embedded session.

Do not use this property if the session is not embedded.
Related Topics
Bullet Adding Sessions to a Portal, Overview
Bullet Adding a Session to any Web Page
Bullet Launcher Control Code Sample