The following public methods are exposed by the TPRI.BaseScreen class.
Protected Overridable Function StartFromAsp( _
ByRef vobjWindow As Object _
) As IntegerDescription:
Start active operation of the screen from an ASP web page.
Parameters:
vobjWindow
Window object of the Document Object Model (DOM) API in the browser.
Return Value:
Zero for success; non-zero for failure.
Remarks:
This method should only be called by the container ASP to initiate activity on the screen.
Protected Overridable Function StartFromForm( _
ByRef vobjForm As Object, _
ByRef host As String, _
ByRef path As String, _
ByRef args As String _
) As IntegerDescription:
Start active operation of the screen.
Parameters:
vobjContainer
Form object containing this screen.
host
Name or IP address of the host system to which the screen should connect..
path
Path to page on host.
args
String argument(s) to pass to screen for initialization/customization.
Return Value:
Zero for success; non-zero for failure.
Remarks:
This method should only be called by the container form to initiate activity on the screen.
The following overridable methods are exposed by the TPRI.BaseScreen class.
Protected Overridable Function StartScreen( _
ByRef vobjContainer As Object _
) As IntegerDescription:
Start active operation of the screen.
Parameters:
vobjContainer
Container object. If screen is started from a web page, this will contain a reference to the Window object of the Document Object Model (DOM) API in the browser.
Return Value:
Zero for success; non-zero for failure.
Remarks:
This method should be overridden by derived classes to provide custom startup functionality.
Description:
Secure the screen according to the specified security level.
Parameters:
securityLevel
Security level of the user. This value is a bitmask of rights provided to the user.
Return Value:
Zero for success; non-zero for failure.
Remarks:
This method should be overridden by derived classes to implement security on individual screens.
Description:
Navigate the current screen to a new page.
Parameters:
URL
URL of the new page. Alternatively, passing the string '@MENU' links the screen back to the most recent menu and passing the string '@BACK' links the screen back to the previous page.
Return Value:
Zero for success; non-zero for failure.
Description:
Navigate the current screen back to the most recent menu page.
Remarks:
Calling this method is equivalent to calling LinkTo("@MENU").
Description:
Navigate the current screen back to the previous page.
Remarks:
Calling this method is equivalent to calling LinkTo("@BACK").