Namespace: Consultingwerk.Forms
Class 
BaseFormHelper Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Forms.BaseFormHelper

Inherits: Progress.Lang.Object

File:BaseFormHelper
Purpose:Helper class for IBaseForm classes
Description:Delegate for BaseForm, BaseRadForm and BaseRadRibbonForm
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Thu Mar 19 17:11:35 CET 2015

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



Top Method Summary
Options Name Purpose
+ CheckFormAuthorizationProvider (IBaseForm) Invoked FormAuthorizationProvider to verify if the current user is allowed to launch the current form
+ CloseDependentForms (IBaseForm, FormClosingEventArgs) Closes the Forms Dependent Forms
+ CHARACTER LoadSettings (IBaseForm, character) Loads stored window settings from the registry
+ RemoveSetting (IBaseForm, character) Removes window settings from the registry
+ RestoreWindowPosition (IBaseForm) Restores the stored window position
+ StoreSettings (IBaseForm, character, character) Stores window settings to the registry
+ StoreWindowPosition (IBaseForm) Stores the window position to the resgistry

Top Constructor Summary
Options Name Purpose
- BaseFormHelper () Constructor for the BaseFormHelper class


Method Detail
Top

PUBLIC CheckFormAuthorizationProvider (IBaseForm)
Purpose: Invoked FormAuthorizationProvider to verify if the current user
is allowed to launch the current form
Notes: Throws FormNotAuthorizedException

Parameters:
poForm Consultingwerk.Forms.IBaseForm
The IBaseForm to store the settings for
Top

PUBLIC CloseDependentForms (IBaseForm, FormClosingEventArgs)
Purpose: Closes the Forms Dependent Forms
Notes:

Parameters:
poForm Consultingwerk.Forms.IBaseForm
The IBaseForm to store the settings for
e System.Windows.Forms.FormClosingEventArgs
The FormClosingEventArgs of the curernt FormClosing event handler
Top

PUBLIC CHARACTER LoadSettings (IBaseForm, character)
Purpose: Loads stored window settings from the registry
Notes:

Parameters:
poForm Consultingwerk.Forms.IBaseForm
The IBaseForm to store the settings for
pcSettingsKey CHARACTER
The key under which the settings for this Form are stored (e.g. Position)
Returns CHARACTER
The string containing the stored window settings
Top

PUBLIC RemoveSetting (IBaseForm, character)
Purpose: Removes window settings from the registry
Notes: Requires the current ISettingsService to implement ISettingsServiceWithDelete
Silently exists if that's not the case

Parameters:
poForm Consultingwerk.Forms.IBaseForm
The IBaseForm to store the settings for
pcSettingsKey CHARACTER
The key under which the settings for this Form are stored (e.g. Position)
Top

PUBLIC RestoreWindowPosition (IBaseForm)
Purpose: Restores the stored window position
Notes:

Parameters:
poForm Consultingwerk.Forms.IBaseForm
The IBaseForm to store the settings for
Top

PUBLIC StoreSettings (IBaseForm, character, character)
Purpose: Stores window settings to the registry
Notes:

Parameters:
poForm Consultingwerk.Forms.IBaseForm
The IBaseForm to store the settings for
pcSettings CHARACTER
The string containing the window settings to be stored
pcSettingsKey CHARACTER
The key under which the settings for this Form are stored (e.g. Position)
Top

PUBLIC StoreWindowPosition (IBaseForm)
Purpose: Stores the window position to the resgistry
Notes:

Parameters:
poForm Consultingwerk.Forms.IBaseForm
The IBaseForm to store the settings for


Constructor Detail
Top

PRIVATE BaseFormHelper ()
Purpose: Constructor for the BaseFormHelper class
Notes: Disallow instance creation



©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       04.02.2020 23:11:47