ClientSession Class Properties

The ApplicationName property contains the name of the application creating the session. The application name is passed to the Logon dialog for display.

The ClientType property is a read-only property that contains the client type as an enumerated value. The client type is one of the types from the ClientTypes enumeration that signifies the client that is currently using the session. Examples of client types include Operator and DataEditor.

The curUser property is a read/write property that contains a reference to the current user object.

The DBMSName property is a read-only property that contains the name of the database management system to which this instance is connected.

The EntitiesRequired property contains a flag that indicates whether or not an application requires entities. If the flag is true, an entity logon (or job-based logon) dialog is presented when a user logs on through the Switch User dialog.

The IsHostedByInTouch property is a read-only property that contains a flag that indicates whether or not InTouch is the host for the controls.

The IsHostedByOMI property is a read-only property that contains a flag that indicates whether or not OMI is the host for the controls.

The IsIntouchUserLoggedIn property is a read-only property that contains a flag that indicates whether or not a user is logged onto InTouch.

The IsOMIUserLoggedIn property is a read-only property that contains a flag that indicates whether or not a user is logged onto OMI.

The IsSingleSignOnEnabled property is a read-only property that contains a flag that indicates if single sign-on in InTouch or OMI is enabled. If InTouch or OMI security is turned on, then MES attempts to use the InTouch/OMI user for signing on to MES.

The LicenseInfo property is a read-only property that contains a reference to the current LicenseInfo object.

The MainFormproperty is a read-only property that contains the value of the Main form of the application. If the top level application is not a .NET program (such as InTouch), the property contains a null value.

The MESVersion property is a read-only property that contains the MES version to which this instance is connected.

The MiddlewareAccess property is a class-level property that contains the Middleware access method.

The SelectForm property is a read-only property that contains an object that implements the ISelectForm. This can be passed to the button bar to allow forms to be selected for the OpenForm button.

The SessionId property is a read-only property that contains the current session ID. If a session has not been started, the property returns a value of -1.

The ShowLanguageIDs property contains a flag that indicates whether language IDs are shown for translatable strings. This can be helpful when trying to translate to a new language, as you see the string IDs in context. This property is used when creating a new LangStrings object, which is done when a user is added to the system. Changing this property does not affect the LangStrings objects of any user already logged onto the system. It is best to set this property at startup.

The SystemAttrs property is a read-only property that contains a reference to the current SystemAttr object. This object is used to check the values of the system attributes.

The TopLevelFont property is a read-only property that contains the font of the parent dialog from which the logon occurred.

The UIPlatform property is a class-level property that contains the Middleware access method.

The UserList property is a read-only property that contains a list of all users who are currently logged onto this session.