Namespace: Consultingwerk.Framework.Session
Class 
SessionManager Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.Session.SessionManager

Inherits: Progress.Lang.Object


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
DetermineUserGroupAssignments () Determines the user group assignments of the current user/login company
CHARACTER GetSessionId () Return a suitable SessionId from any session
LOGICAL Login (IUserCredentials) Performs the application login
Login (Form, logical) Performs the application login
Login (logical) Performs the application login
LogSessionManagerProperties () Writes the current SessionManager properties to the log file
OnAfterLogin () Raises the AfterLogin event
OnAfterShowLoginDialog () Raises the AfterShowLoginDialog event
OnBeforeLogin (BeforeLoginEventArgs) Raises the BeforeShowLoginDialog event
OnBeforeShowLoginDialog (CancelableEventArgs) Raises the BeforeShowLoginDialog event
OnLanguageDisplayNameChanged () Raises the LanguageDisplayNameChanged event
OnLanguageIsoCodeChanged () Raises the LanguageDisplayNameChanged event
OnLanguageKeyChanged () Raises the LanguageDisplayNameChanged event
OnLoginCompanyKeyChanged () Raises the LoginCompanyKeyChanged event
OnLoginCompanyNameChanged () Raises the LoginCompanyNameChanged event
OnLoginCompleted () Raises the LoginCompleted event
OnProcessingDateChanged () Raises the ProcessingDateChanged event
OnUserNameChanged () Raises the UserNameChanged event
Reset () Resets all Session Manager Properties to their initial values
ResetProperties () Resets all Session Manager Properties to their initial values

Top Constructor Summary
Options Name Purpose
SessionManager () Static constructor for the SessionManager class
SessionManager () Disallow instance creation

Top Event Summary
Options Name Purpose
AfterLogin () Raised after the user credentials are validated
AfterShowLoginDialog () Raised after the GUI login Dialog is shown
BeforeLogin (BeforeLoginEventArgs) Raised before the user credentials are validated
BeforeShowLoginDialog (CancelableEventArgs) Raised before the GUI login Dialog is shown
LanguageDisplayNameChanged () Raised when the DisplayLanguage Changes
LanguageIsoCodeChanged () Raised when the Language Iso Code Changes
LanguageKeyChanged () Raised when the Language Key Changes
LoginCompanyKeyChanged () Raised when the LoginCompanyKey has changed
LoginCompanyNameChanged () Raised when the LoginCompanyName has changed
LoginCompleted () Raised when the Login has completed
ProcessingDateChanged () Raised when the ProcessingDate has changed
UserNameChanged () Raised when the UserName has changed

Top Property Summary
Options Name Purpose
RAW ClientPrincipal
HANDLE ContextDataset
Consultingwerk.Framework.Session.ContextDatasetOriginEnum ContextDatasetOrigin
LOGICAL IsRestrictedTokensSet
CHARACTER LanguageDisplayName
CHARACTER LanguageIsoCode
CHARACTER LanguageKey
CHARACTER LoginCompanyImageLarge
CHARACTER LoginCompanyImageSmall
CHARACTER LoginCompanyKey
CHARACTER LoginCompanyName
CHARACTER LoginCompanyReferenceChar
DECIMAL LoginCompanyReferenceDecimal
INTEGER LoginCompanyReferenceInteger
CHARACTER LoginCompanyShortName
LOGICAL LoginFormAllowStorePassword
CHARACTER LoginFormClassName
LOGICAL LoginFormShowProcessingDate
DATE ProcessingDate
LONGCHAR RestrictedTokens
CHARACTER ServerCustomLogEntries
LOGICAL ServerDebugMode
CHARACTER ServerLogEntryTypes
CHARACTER UserEmail
CHARACTER UserFullName
CHARACTER UserGroupKeys
CHARACTER UserGroupNames
CHARACTER UserKey
CHARACTER UserName


Method Detail
Top

DetermineUserGroupAssignments ()
Purpose: Determines the user group assignments of the current user/login company
Notes: Assigns SessionManager UserGroupKeys and UserGroupNames properties

Top

CHARACTER GetSessionId ()
Purpose: Return a suitable SessionId from any session
Notes: Typically used for logical application locks

Returns CHARACTER
A session identifier.
Top

LOGICAL Login (IUserCredentials)
Purpose: Performs the application login
Notes: Actual Login routine including

Parameters:
poUserCredentials Consultingwerk.Framework.IUserCredentials
The IUserCredentials with the data for this method
Returns LOGICAL
Logical value indicating the success of the operation
Top

Login (Form, logical)
Purpose: Performs the application login
Notes: Shows the Login Dialog

Parameters:
poParent System.Windows.Forms.Form
The parent Form for the Login Dialog
lOk LOGICAL
OUTPUT Logical value indicating if login was successful
Top

Login (logical)
Purpose: Performs the application login
Notes: Shows the Login Dialog

Parameters:
plOk LOGICAL
OUTPUT Logical value indicating if login was successful
Top

LogSessionManagerProperties ()
Purpose: Writes the current SessionManager properties to the log file
Notes: The method requires the "SessionManager" custom LogEntryType activated
within the LogManager

Top

OnAfterLogin ()
Purpose: Raises the AfterLogin event
Notes:

Top

OnAfterShowLoginDialog ()
Purpose: Raises the AfterShowLoginDialog event
Notes:

Top

OnBeforeLogin (BeforeLoginEventArgs)
Purpose: Raises the BeforeShowLoginDialog event
Notes:

Parameters:
e Consultingwerk.Framework.Session.BeforeLoginEventArgs
The BeforeLoginEventArgs with the data for the event
Top

OnBeforeShowLoginDialog (CancelableEventArgs)
Purpose: Raises the BeforeShowLoginDialog event
Notes:

Parameters:
e Consultingwerk.CancelableEventArgs
The CancelEventArgs with the data for the event
Top

OnLanguageDisplayNameChanged ()
Purpose: Raises the LanguageDisplayNameChanged event
Notes:

Top

OnLanguageIsoCodeChanged ()
Purpose: Raises the LanguageDisplayNameChanged event
Notes:

Top

OnLanguageKeyChanged ()
Purpose: Raises the LanguageDisplayNameChanged event
Notes:

Top

OnLoginCompanyKeyChanged ()
Purpose: Raises the LoginCompanyKeyChanged event
Notes:

Top

OnLoginCompanyNameChanged ()
Purpose: Raises the LoginCompanyNameChanged event
Notes:

Top

OnLoginCompleted ()
Purpose: Raises the LoginCompleted event
Notes:

Top

OnProcessingDateChanged ()
Purpose: Raises the ProcessingDateChanged event
Notes:

Top

OnUserNameChanged ()
Purpose: Raises the UserNameChanged event
Notes:

Top

Reset ()
Purpose: Resets all Session Manager Properties to their initial values
Notes:

Top

ResetProperties ()
Purpose: Resets all Session Manager Properties to their initial values
Notes:



Constructor Detail
Top

STATIC SessionManager ()
Purpose: Static constructor for the SessionManager class
Notes:

Top

SessionManager ()
Purpose: Disallow instance creation
Notes:



Event Detail
Top

AfterLogin ()
Purpose: Raised after the user credentials are validated
Notes:

Top

AfterShowLoginDialog ()
Purpose: Raised after the GUI login Dialog is shown
Notes:

Top

BeforeLogin (BeforeLoginEventArgs)
Purpose: Raised before the user credentials are validated
Notes:

Parameters:
e Consultingwerk.Framework.Session.BeforeLoginEventArgs
The BeforeLoginEventArgs with the data for the event
Top

BeforeShowLoginDialog (CancelableEventArgs)
Purpose: Raised before the GUI login Dialog is shown
Notes:

Parameters:
e Consultingwerk.CancelableEventArgs
The CancelEventArgs with the data for the event
Top

LanguageDisplayNameChanged ()
Purpose: Raised when the DisplayLanguage Changes
Notes:

Top

LanguageIsoCodeChanged ()
Purpose: Raised when the Language Iso Code Changes
Notes:

Top

LanguageKeyChanged ()
Purpose: Raised when the Language Key Changes
Notes:

Top

LoginCompanyKeyChanged ()
Purpose: Raised when the LoginCompanyKey has changed
Notes:

Top

LoginCompanyNameChanged ()
Purpose: Raised when the LoginCompanyName has changed
Notes:

Top

LoginCompleted ()
Purpose: Raised when the Login has completed
Notes:

Top

ProcessingDateChanged ()
Purpose: Raised when the ProcessingDate has changed
Notes:

Top

UserNameChanged ()
Purpose: Raised when the UserName has changed
Notes:



Property Detail
Top

RAW ClientPrincipal

Returns RAW
Top

HANDLE ContextDataset

Returns HANDLE
Top

Consultingwerk.Framework.Session.ContextDatasetOriginEnum ContextDatasetOrigin

Returns Consultingwerk.Framework.Session.ContextDatasetOriginEnum
Top

LOGICAL IsRestrictedTokensSet

Returns LOGICAL
Top

CHARACTER LanguageDisplayName

Returns CHARACTER
Top

CHARACTER LanguageIsoCode

Returns CHARACTER
Top

CHARACTER LanguageKey

Returns CHARACTER
Top

CHARACTER LoginCompanyImageLarge

Returns CHARACTER
Top

CHARACTER LoginCompanyImageSmall

Returns CHARACTER
Top

CHARACTER LoginCompanyKey

Returns CHARACTER
Top

CHARACTER LoginCompanyName

Returns CHARACTER
Top

CHARACTER LoginCompanyReferenceChar

Returns CHARACTER
Top

DECIMAL LoginCompanyReferenceDecimal

Returns DECIMAL
Top

INTEGER LoginCompanyReferenceInteger

Returns INTEGER
Top

CHARACTER LoginCompanyShortName

Returns CHARACTER
Top

LOGICAL LoginFormAllowStorePassword

Returns LOGICAL
Top

CHARACTER LoginFormClassName

Returns CHARACTER
Top

LOGICAL LoginFormShowProcessingDate

Returns LOGICAL
Top

DATE ProcessingDate

Returns DATE
Top

LONGCHAR RestrictedTokens

Returns LONGCHAR
Top

CHARACTER ServerCustomLogEntries

Returns CHARACTER
Top

LOGICAL ServerDebugMode

Returns LOGICAL
Top

CHARACTER ServerLogEntryTypes

Returns CHARACTER
Top

CHARACTER UserEmail

Returns CHARACTER
Top

CHARACTER UserFullName

Returns CHARACTER
Top

CHARACTER UserGroupKeys

Returns CHARACTER
Top

CHARACTER UserGroupNames

Returns CHARACTER
Top

CHARACTER UserKey

Returns CHARACTER
Top

CHARACTER UserName

Returns CHARACTER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       30.03.2026 11:04:32