The CEWebFormRendererEventArgs is a class with a collection of objects that is passed in each event. Not all properties of the CEWebFormRendererEventArgs are applicable for every type of event. Before using any particular property, check that it is used in the particular event that you are processing.
Properties
Property | Description |
BypassStatusHandling | A boolean value to indicate that the CE Web Form Renderer should not open any error message windows to show errors that have been raised as a result of this transaction. Valid in StatusLineEvent, PreTransactonEvent and PostTransactionEvent. Default value is false |
BypassTransaction | A boolean value to indicate that the CE Web Form Renderer should not call the transaction() method, but should continue processing as if the transaction had already happened. It is expected that the programmer of the hosting page has manipulated the HostSession object to provide an altered Current Ispec, and/or Status object. Valid in PreTransactionEvent. Default value is false. When setting this property value to true, the programmer of the hosting page should also set the ReturnCode to an appropriate value for subsequent processing. Refer to the CEWindowsAPI.ResponseCodes for a list of values. |
CancelFormRendering | A boolean value to indicate that the CE Web Form Renderer should cease processing, and HIDE the Renderer control to prevent any further user interaction. The CE Web Form Renderer can be re-activated by calling DisplayIspec() again. The CE Web Form Renderer is still valid, and its Host Session object can by used by the programmer of the hosting page, it is just not visible. Valid in PreTransactionEvent and PostTransactionEvent. Default value is false. |
EventType | A string to indicate what sort of Event this CEWebFormRendererEventArgs was sent for. |
ReturnCode | A ResponseCodes value containing the most recent ResponseCode from the host. If the programmer intends to BypassTransaction, the ReturnCode should be set to an appropriate value for the data that is supplied in the CurrentIspec or Status object. If the programmer intends to change the data in a PostTransactionEvent, the ReturnCode should be set to an appropriate value. Valid in PreTransactionEvent and PostTransactionEvent. |
WebSession | The session object used by the CE Web Form Renderer control for maintaining the web session. The CE Web Form Renderer uses this object for storing values that need to be persisted across the entire session with the browser user. Valid in all events. |
HostSession | The LINCEnvironment session object used by Component Enabler for maintaining the session with the host system. Passed in the event arguments for convenience. Valid in PreTransactionEvent, PostTransactionEvent, and StatusLineEvent. |
Status | The LINCStatus line object for the most recent transaction. Passed in the event for convenience. Valid in PreTransactionEvent, PostTransactionEvent, and StatusLineEvent. |
Objects
The CE Web Form Renderer has three objects that allow the user to control a session.
The HostSession object is a CEWindowsAPI.LINCEnvironment object used for controlling the session with the application on the host system. Using this object, the programmer can control the entire session, or just some parts.
The CE Web Form Renderer also has a Status object. This is a CEWindowsAPI.LINCStatus object, that the CE Web Form Renderer uses in all of its internal logic. i.e. the Status object has the results of all transactions performed by the CE Web Form Renderer.
Refer to the CEWindowsAPI class reference for more information on both these objects.
The WebSession object is used internally by the CE Web Form Renderer for controlling and storing values that needs to be persisted across the entire session with the web browser end user.