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

Inherits: Progress.Lang.Object

File:FormHelper
Syntax:Static methods only, private constructor to disallow
instance creation
Description:Methods which helps to Handle Forms
Author(s):Marko Rüterbories / Consultingwerk Ltd.
Created:Thu Oct 23 14:39:56 CEST 2008
Notes:This file is intended for GUI for .NET only

Navigate to: Methods | Constructors | Events | Properties



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 FindRunningFormInObjects (Class) Locates a running instance of a Form Class in the SESSION:FIRST-OBJECT chain of objects
+ 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
+ System.Windows.Forms.Screen GetScreenOfPoint (integer, integer) Getting the Screen Object of a Point indentificated by piTop and piLeft.
+ 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 these Points are on a valid Display but the right side is not on a valid one. 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

PUBLIC 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

PUBLIC 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

PUBLIC System.Windows.Forms.Control FindParentOfType (Control, Type)
Purpose: Seeks the Control hierarchie up for a Parent of the given type
Notes:

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

PRIVATE Progress.Windows.Form FindRunningFormInObjects (Class)
Purpose: Locates a running instance of a Form Class in the SESSION:FIRST-OBJECT
chain of objects
Notes: Used only as a workaround, when iterating the SESSION:FIRST-FORM
chain of Progress.Windows.Form objects fails with error 15580.

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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC LOGICAL IsFormOnValidDisplay (integer, integer, integer, integer)
Purpose: Test whether the given Point indentificated by piTop and
piLeft is on a valid Display. If these Points are on a valid
Display but the right side is not on a valid one. The Form
is repositioned by setting new values for piTop and piLeft.
Notes: If these Points are on a valid Display but the right side is not on a
valid one. The Form is repositioned by setting new values for piTop and piLeft.

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

PUBLIC 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

PUBLIC 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

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



©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:46:29