Namespace: Consultingwerk.Framework
Interface 
IProgressManager Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.Framework.ProgressManager

File:IProgressManager
Purpose:Describes Methods required by classes that can
handle Progress updates on the UI
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Dec 15 12:07:47 CET 2010
Purpose: Event raised when the generic progress has changed
Notes:



Top Method Summary
Options Name Purpose
+ ClearProgress () Clears the generic progress display (i.e. main window progress bar)
+ ClearProgress (character) Clears the progress display for the given scope (i.e. a specific application window referenced by a GUID)
+ DisplayProgress (character, integer, integer) Sets the generic progress (i.e. main window progress bar)
+ DisplayProgress (character, integer, integer, character) Sets the progress for the given scope (i.e. a specific application window referenced by a GUID)

Top Event Summary
Options Name Purpose
+ GenericProgressChanded (IProgressManager, character, integer, integer) Event raised when the generic progress has changed
+ ScopedProgressChanded (IProgressManager, character, integer, integer, character) Event raised when a scoped scoped progress has updated


Method Detail
Top

PUBLIC ClearProgress ()

Purpose: Clears the generic progress display (i.e. main window progress bar)
Notes:

Top

PUBLIC ClearProgress (character)

Purpose: Clears the progress display for the given scope
(i.e. a specific application window referenced by a GUID)
Notes:

Parameters:
pcScope CHARACTER
The name of the scope for which the progress display should be cleared
Top

PUBLIC DisplayProgress (character, integer, integer)

Purpose: Sets the generic progress (i.e. main window progress bar)
Notes:

Parameters:
pcLabel CHARACTER
The label for the progress to display
piValue INTEGER
The current value to display
piMax INTEGER
The Maximum value for the progress to display
Top

PUBLIC DisplayProgress (character, integer, integer, character)

Purpose: Sets the progress for the given scope
(i.e. a specific application window referenced by a GUID)
Notes:

Parameters:
pcLabel CHARACTER
The label for the progress to display
piValue INTEGER
The current value to display
piMax INTEGER
The Maximum value for the progress to display
pcScope CHARACTER
The name of the scope for the current progress to display


Event Detail
Top

PUBLIC GenericProgressChanded (IProgressManager, character, integer, integer)

Purpose: Event raised when the generic progress has changed
Notes:

Parameters:
sender Consultingwerk.Framework.IProgressManager
The reference to the IProgressManager that raised the event
pcLabel CHARACTER
The label for the current progress
piValue INTEGER
The current progress value
piMax INTEGER
The Maximum value for the current progress
Top

PUBLIC ScopedProgressChanded (IProgressManager, character, integer, integer, character)

Purpose: Event raised when a scoped scoped progress has updated
Notes:

Parameters:
sender Consultingwerk.Framework.IProgressManager
The reference to the IProgressManager that raised the event
pcLabel CHARACTER
The label for the current progress
piValue INTEGER
The current progress value
piMax INTEGER
The Maximum value for the current progress
pcScope CHARACTER
The name of the scope this progress event belongs to


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       29.06.2022 12:41:14