Namespace: Consultingwerk.Util
Class 
FormHelper Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Util.FormHelper

Inherits: Progress.Lang.Object


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



Top Method Summary
Options Name Purpose
ActivateForm (Form) Activates a Form by un-Minimizing and Activating it
System.Windows.Forms.Control FindActiveChildControl (Form) Finds the active child control in a Form
System.Windows.Forms.Control FindParentOfType (Control, Type) Seeks the Control hierarchie up for a Parent of the given type
Progress.Windows.Form FindRunningFormInstance (character) Locates a running instance of a Form Class in the SESSION:FIRST-FORM chain of Progress.Windows.Form objects
Progress.Windows.Form FindRunningFormInstance (Class) Locates a running instance of a Form Class in the SESSION:FIRST-FORM chain of Progress.Windows.Form objects
Progress.Windows.Form FindRunningFormInstance (raw) Locates a running instance of a Form based on a RAW hash value
System.Drawing.Rectangle GetScreenBounds (Screen[]) Returns the bounds of the given screens
INTEGER GetScreenIndexOfPoint (integer, integer, Rectangle[]) Returns the index of the screen (in the given array of screen bounds) the point identified by piTop and piLeft is located on
System.Windows.Forms.Screen GetScreenOfPoint (integer, integer) Getting the Screen Object of a Point indentificated by piTop and piLeft.
LOGICAL HasOpenChildForms (Form) Returns true when there is at least one open child Form besides the given main Form (the MDI container) - either an MDI child Form or a non-MDI Form opened outside of the MDI container
LOGICAL HasOpenChildForms (Form, Class) Returns true when there is at least one open child Form besides the given main Form (the MDI container) - either an MDI child Form or a non-MDI Form opened outside of the MDI container
LOGICAL IsActive (Form) Determines if a Form is active
LOGICAL IsFormOnValidDisplay (integer, integer, integer, integer) Test whether the given Point indentificated by piTop and piLeft is on a valid Display. If this Point is on a valid Display but another corner of the Form is not on a valid one, the Form is repositioned by setting new values for piTop and piLeft.
LOGICAL IsFormOnValidDisplay (integer, integer, integer, integer, Rectangle[]) Test whether the given Point indentificated by piTop and piLeft is on one of the given screens. If this Point is on a screen but another corner of the Form is not, the Form is repositioned by setting new values for piTop and piLeft.
LOGICAL IsFormOnValidDisplay (integer, integer) Test whether the given Point indentificated by piTop and piLeft is on a valid Display.
ShowDialog (Form, DialogResult) Shows a Form as a dialog

Top Constructor Summary
Options Name Purpose
FormHelper () Protected default constructor.


Method Detail
Top

ActivateForm (Form)
Purpose: Activates a Form by un-Minimizing and Activating it
Notes:

Parameters:
poForm Progress.Windows.Form
The Progress.Windows.Form to Activate
Top

System.Windows.Forms.Control FindActiveChildControl (Form)
Purpose: Finds the active child control in a Form
Notes:

Parameters:
poForm System.Windows.Forms.Form
The reference to the Form
Returns System.Windows.Forms.Control
The reference to the active Control
Top

System.Windows.Forms.Control FindParentOfType (Control, Type)
Purpose: Seeks the Control hierarchie up for a Parent of the given type
Notes: SCL-5951: Delegates to ControlHelper:FindParentControlOfType,
which validates the input parameters

Parameters:
poControl System.Windows.Forms.Control
The reference to the Control to return the Parent for
poType System.Type
The reference to the type of the parent control to return
Returns System.Windows.Forms.Control
The reference to the parent control
Top

Progress.Windows.Form FindRunningFormInstance (character)
Purpose: Locates a running instance of a Form Class in the SESSION:FIRST-FORM
chain of Progress.Windows.Form objects
Notes:

Parameters:
pcFormType CHARACTER
The Form's fully qualified class name
Returns Progress.Windows.Form
The reference to the running Form
Top

Progress.Windows.Form FindRunningFormInstance (Class)
Purpose: Locates a running instance of a Form Class in the SESSION:FIRST-FORM
chain of Progress.Windows.Form objects
Notes:

Parameters:
poClass Progress.Lang.Class
The Form's class reference (Progress.Lang.Class instance)
Returns Progress.Windows.Form
The reference to the running Form
Top

Progress.Windows.Form FindRunningFormInstance (raw)
Purpose: Locates a running instance of a Form based on a RAW hash value
Notes: Forms need to implement the IFormWithHash interface

Parameters:
prFormHash RAW
The hash value of the Form
Returns Progress.Windows.Form
The reference to the running Form
Top

System.Drawing.Rectangle GetScreenBounds (Screen[])
Purpose: Returns the bounds of the given screens
Notes: SCL-5951

Parameters:
poScreens System.Windows.Forms.Screen
The array of screens
Returns System.Drawing.Rectangle
The array with the bounds of the screens, indeterminate when no screens are passed in
Top

INTEGER GetScreenIndexOfPoint (integer, integer, Rectangle[])
Purpose: Returns the index of the screen (in the given array of screen
bounds) the point identified by piTop and piLeft is located on
Notes: SCL-5951: Pure calculation used by GetScreenOfPoint and
IsFormOnValidDisplay. The screen bounds are passed in, so the
calculation can be tested independent of the monitor layout.
A point on the edge of a screen is located on that screen, when
screens share an edge the first matching screen is returned

Parameters:
piTop INTEGER
The top coordinate of the point
piLeft INTEGER
The left coordinate of the point
poScreenBounds System.Drawing.Rectangle
The bounds of the screens connected to the system
Returns INTEGER
The index of the screen the point is located on, 0 when the point is not located on any screen
Top

System.Windows.Forms.Screen GetScreenOfPoint (integer, integer)
Purpose: Getting the Screen Object of a Point indentificated by
piTop and piLeft.
Notes:

Parameters:
piTop INTEGER
The top coordinate of the point
piLeft INTEGER
The left coordinate of the point
Returns System.Windows.Forms.Screen
The reference to the Screen the point is located on
Top

LOGICAL HasOpenChildForms (Form)
Purpose: Returns true when there is at least one open child Form besides
the given main Form (the MDI container) - either an MDI child
Form or a non-MDI Form opened outside of the MDI container
Notes: Enumerates System.Windows.Forms.Application:OpenForms. Only visible
Forms are taken into account; the main Form itself and other MDI
container Forms are skipped (SCL-5799)

Parameters:
poMainForm System.Windows.Forms.Form
The reference to the main Form (MDI container)
Returns LOGICAL
Logical value indicating if there is at least one open child Form
Top

LOGICAL HasOpenChildForms (Form, Class)
Purpose: Returns true when there is at least one open child Form besides
the given main Form (the MDI container) - either an MDI child
Form or a non-MDI Form opened outside of the MDI container
Notes: Enumerates System.Windows.Forms.Application:OpenForms. Only visible
Forms are taken into account; the main Form itself, other MDI
container Forms and instances of the ignored Form class (e.g. a
start form / welcome screen) are skipped (SCL-5799)

Parameters:
poMainForm System.Windows.Forms.Form
The reference to the main Form (MDI container)
poIgnoredFormClass Progress.Lang.Class
The class of Forms that should not be counted (e.g. the start form), ? to count every Form
Returns LOGICAL
Logical value indicating if there is at least one open child Form
Top

LOGICAL IsActive (Form)
Purpose: Determines if a Form is active
Notes: For MDI Child Forms, this is only True, when the Form and the MDI
Container Form are Active

Parameters:
poForm System.Windows.Forms.Form
The reference to the Form
Returns LOGICAL
Logical value indicating if the Form is active
Top

LOGICAL IsFormOnValidDisplay (integer, integer, integer, integer)
Purpose: Test whether the given Point indentificated by piTop and
piLeft is on a valid Display. If this Point is on a valid
Display but another corner of the Form is not on a valid one,
the Form is repositioned by setting new values for piTop and piLeft.
Notes: The Form is moved up and/or left so that it fits onto the
display of its top left corner. When the Form does not fit onto
that display at all, piTop and piLeft remain unchanged.
SCL-5951: The Form is repositioned when any of the top right,
bottom right or bottom left corners is not on a valid display
(previously only when both right corners were off-screen, so a
bottom-only overflow was never corrected)

Parameters:
piTop INTEGER
The top coordinate of the point, INPUT-OUTPUT as it may require to move the Form when it's to large
piLeft INTEGER
The left coordinate of the point, INPUT-OUTPUT as it may require to move the Form when it's to large
piWidth INTEGER
The width of the Form
piHeight INTEGER
The height of the Form
Returns LOGICAL
Logical value indicating if the Form is on a valid display
Top

LOGICAL IsFormOnValidDisplay (integer, integer, integer, integer, Rectangle[])
Purpose: Test whether the given Point indentificated by piTop and
piLeft is on one of the given screens. If this Point is on a
screen but another corner of the Form is not, the Form is
repositioned by setting new values for piTop and piLeft.
Notes: SCL-5951: Pure calculation of the public IsFormOnValidDisplay
method. The screen bounds are passed in, so the calculation can
be tested independent of the monitor layout

Parameters:
piTop INTEGER
The top coordinate of the point, INPUT-OUTPUT as it may require to move the Form when it's to large
piLeft INTEGER
The left coordinate of the point, INPUT-OUTPUT as it may require to move the Form when it's to large
piWidth INTEGER
The width of the Form
piHeight INTEGER
The height of the Form
poScreenBounds System.Drawing.Rectangle
The bounds of the screens connected to the system
Returns LOGICAL
Logical value indicating if the Form is on a valid display
Top

LOGICAL IsFormOnValidDisplay (integer, integer)
Purpose: Test whether the given Point indentificated by piTop and
piLeft is on a valid Display.
Notes:

Parameters:
piTop INTEGER
The top coordinate of the point
piLeft INTEGER
The left coordinate of the point
Returns LOGICAL
Logical value indicating if the Form is on a valid display
Top

ShowDialog (Form, DialogResult)
Purpose: Shows a Form as a dialog
Notes: Useful to circumvent missing -IOEverywhere 1 parameters during compile
time

Parameters:
poForm System.Windows.Forms.Form
The System.Windows.Forms.Form to show
poDialogResult System.Windows.Forms.DialogResult
OUTPUT The DialogResult of the Form


Constructor Detail
Top

FormHelper ()
Purpose: Protected default constructor.
Notes: There's no need to create instances of the helper classes



©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       10.10.2026 15:35:30