Properties
The properties of the CE Web Form Renderer can be set via the Properties Window of the Visual Studio web forms painter or in the code of the hosting page.
Most properties relate to items required to identify and connect to the host runtime system and some properties allow control over the behavior of the rendered forms.
All the properties are described in the following table.
| Property | Description |
|---|---|
| AppDirRelativePath | Specifies the relative path to directories where the web user controls for a given application which are displayed by the CE Web Form Renderer are located. Only required when using two or more CE Web Form Renderer controls on a web page to different systems. |
| ApplicationName | The name of the runtime application used in the generation |
| ApplicationSwitching | Enables application switching. |
| AutoPopupErrorWindow | Allows popup error window. |
| BundleName | The name of the bundle used in the generation. |
| ConfigName | Name of configuration to read from Web.config when UseWebConfig is enabled. |
| ConnectionMode | Type of client connecting. This effects the values of GLB.GUI and GLB.STYLE in the runtime logic. |
| DefaultImageType | Default image type/extension. |
| DisplayName | The name of the system for display purposes. |
| EnableMessageQueuing | Enables message queuing. |
| FireUpIspecForPooling | Identifies the name of the fireup ispec used when object pooling is enabled. |
| HostDomain | Host login domain. |
| HostLogin | Host login userid. |
| HostPassword | Host login password. |
| HostURI | URI connection details of host application. |
| HostViewName | View name of host system used by Remote Access Server. |
| IspecModelRootDirectory | Root location of Ispec model dll's. |
| LogFile | Log file used when logging is enabled. |
| LoggingEnabled | Enables Component Enabler logging and CE Web Form Renderer logging. |
| LogLevel | Level of Component Enabler logging. |
| ObjectPoolingEnabled | Enables object pooling of the Component Enabler host connection object. |
| ObjectPoolingType | Full class name of object pool type. |
| PackagePrefix | Prefix of generated application bundle. |
| PreserveWhiteSpace | Preserves spaces. |
| UseWebConfig | Enables reading configuration parameters from the Web.config xml file. |
Methods
All the methods relevant to users are described in the following table.
| Method | Description |
|---|---|
| AutoConnect() | AutoConnect using values set on properties on this Web Form Renderer object prior to calling this method. |
| AutoConnect(string configName) | AutoConnect reading configuration parameters from web.config for the specified configuration name. |
| CloseSession() | This method closes the connection to the host system, raises the SessionClosed event and clears the session state information. |
| DisplayIspec() | This method displays the current Ispec as known by the Session. If there is no Current Ispec, a list of ispecs in the bundle are shown. |
| DisplayIspec(bool forceDisplay) | This method displays the current Ispec as known by the Session. If there is no Current Ispec, a list of ispecs in the bundle are shown. When forceDisplay is true, the ispec is displayed regardless of the status of CancelFormRendering, When forceDisplay is false, the status of CancelFormRendering is honored and depending on this, the Ispec will or will not be displayed. |
| DisplayUserControl(string userControlName) | This method displays a 'normal' nonIspec user control such as TimeOut.ascx and SelectIspec.ascx. |
| GetErrorText(ResponseCo des errorCode, LINCStatus objStatusLine) | This method returns a text string for the specified ResponseCode errorCode. |
| GetReasonText(LINCField ExceptionReasons reasonCode) | This method returns a text string for the specified LINC Field Exception Reason code. |
| PagePopup(string pageUrl) | This method registers appropriate Javascript to open a page located at the specified URL in a popup. |
| ReplayMessages() | This method re-displays messages/errors for the last transaction. |
| SetSessionProperties() | This method writes/persists the CE Web Form Renderer configuration properties to the Web Session object. This persists the properties for the duration of the web session. In case the web session times out, this method must be called again when reestablishing the session. This method is always called when using the AutoConnect method. |
Events
The CE Web Form Renderer raises seven types of events at various stages in the processing cycle of Web User Control forms. The hosting page might optionally intercept these events, examine data, take control of the session, or allow the CE Web Form Renderer to continue processing.
The programmer of the hosting page needs to add their own event handler, and then wire it to the event processing of the CE Web Form Renderer. Each Event passes a CEWebFormRendererEventArgs object. The contents of this object change depending on the type of event.
All the events are described below