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

Inherits: Progress.Lang.Object


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



Top Method Summary
Options Name Purpose
CHARACTER BuildSplitterSettingsKey (character, character, character) Builds the registry settings key for a single UltraSplitter, taking an optional key prefix into account (used by DynamicControlGroup to scope keys per group instance, including the full chain of enclosing groups for nested cases).
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
CollectUltraSplitters (Control, Control>, Type) Collects all descendant Infragistics.Win.Misc.UltraSplitter Controls reachable from the given root Control, into the supplied list. Recursion stops at any control that is-a poStopRecursionType (when provided), so that a sub-tree owned by another store/restore scope (typically a DynamicControlGroup) is left for that scope to walk. The root Control itself is not subject to the stop-recursion check.
CHARACTER LoadSettings (IBaseForm, character) Loads stored window settings from the registry
LONGCHAR LoadSettingsLong (IBaseForm, character) Loads stored window settings from the registry
RemoveSetting (IBaseForm, character) Removes window settings from the registry
RestoreUltraSplitterPositions (IBaseForm, Control, character, Type) Restores the position of the UltraSplitter Controls contained in the given root Control. Settings are loaded from the SettingsService using the WindowPositionRegistryKey of the given Form.
RestoreWindowPosition (IBaseForm) Restores the stored window position
StoreSettings (IBaseForm, character, character) Stores window settings to the registry
StoreSettingsLong (IBaseForm, longchar, character) Stores window settings to the registry
StoreUltraSplitterPositions (IBaseForm, Control, character, Type) Stores the position of the UltraSplitter Controls contained in the given root Control. Settings are stored via the SettingsService using the WindowPositionRegistryKey of the given Form.
StoreWindowPosition (IBaseForm) Stores the window position to the resgistry

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


Method Detail
Top

CHARACTER BuildSplitterSettingsKey (character, character, character)
Purpose: Builds the registry settings key for a single UltraSplitter, taking
an optional key prefix into account (used by DynamicControlGroup to
scope keys per group instance, including the full chain of
enclosing groups for nested cases).
Notes: SCL-3805. With an empty prefix the key shape matches the original
BaseForm behavior (splitter:<splitter>:<sibling>) so existing
registry data for splitters that sit directly on a Form is
preserved.

Parameters:
pcKeyPrefix CHARACTER
The ":"-joined prefix (e.g. "OuterGroup:InnerGroup") or empty
pcSplitterName CHARACTER
The Name of the UltraSplitter
pcSiblingName CHARACTER
The Name of the sibling panel whose Size is stored
Returns CHARACTER
The full settings key
Top

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

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

CollectUltraSplitters (Control, Control>, Type)
Purpose: Collects all descendant Infragistics.Win.Misc.UltraSplitter Controls
reachable from the given root Control, into the supplied list.
Recursion stops at any control that is-a poStopRecursionType (when
provided), so that a sub-tree owned by another store/restore scope
(typically a DynamicControlGroup) is left for that scope to walk.
The root Control itself is not subject to the stop-recursion check.
Notes: SCL-3805.

Parameters:
poRoot System.Windows.Forms.Control
The Control whose descendants should be walked
poList System.Collections.Generic.List
The List receiving matching UltraSplitter Controls
poStopRecursionType System.Type
The Control type at which recursion should stop (the unknown value disables this filter)
Top

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

LONGCHAR LoadSettingsLong (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 LONGCHAR
The string containing the stored window settings
Top

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

RestoreUltraSplitterPositions (IBaseForm, Control, character, Type)
Purpose: Restores the position of the UltraSplitter Controls contained in
the given root Control. Settings are loaded from the SettingsService
using the WindowPositionRegistryKey of the given Form.
Notes: SCL-3805. Used both by BaseForm:RestoreUltraSplitterPosition (with
the Form itself as the root) and by DynamicControlGroup, so that a
SplitContainer rendered inside a group restores its position once
the group's lazy/late layout has settled. The key prefix scopes
keys per group instance (full ancestor chain for nested groups);
the stop-recursion type prevents one scope's walk from also touching
splitters owned by another scope.

Parameters:
poForm Consultingwerk.Forms.IBaseForm
The IBaseForm instance providing the WindowPositionRegistryKey
poRoot System.Windows.Forms.Control
The root Control whose descendant UltraSplitter Controls should be restored
pcKeyPrefix CHARACTER
The ":"-joined key prefix scoping the registry keys (empty for the Form root)
poStopRecursionType System.Type
The Control type at which the descendant walk stops (the unknown value disables this filter)
Top

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

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

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

StoreSettingsLong (IBaseForm, longchar, character)
Purpose: Stores window settings to the registry
Notes:

Parameters:
poForm Consultingwerk.Forms.IBaseForm
The IBaseForm to store the settings for
plcSettings LONGCHAR
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

StoreUltraSplitterPositions (IBaseForm, Control, character, Type)
Purpose: Stores the position of the UltraSplitter Controls contained in
the given root Control. Settings are stored via the SettingsService
using the WindowPositionRegistryKey of the given Form.
Notes: SCL-3805. Used by BaseForm:StoreUltraSplitterPosition with the Form
itself as the root; DynamicControlGroup invokes the same helper
with its own root, prefix and stop-recursion type so that a
splitter inside the group is persisted exactly once and the keys
are scoped per group instance (avoiding collisions when the same
SplitContainer template is rendered into multiple groups).

Parameters:
poForm Consultingwerk.Forms.IBaseForm
The IBaseForm instance providing the WindowPositionRegistryKey
poRoot System.Windows.Forms.Control
The root Control whose descendant UltraSplitter Controls should be stored
pcKeyPrefix CHARACTER
The ":"-joined key prefix scoping the registry keys (empty for the Form root)
poStopRecursionType System.Type
The Control type at which the descendant walk stops (the unknown value disables this filter)
Top

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

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



©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.05.2026 16:18:42