Namespace: Consultingwerk.Framework
Class 
WaitStateManager Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.WaitStateManager

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Framework.IRaisesWaitStateChangedEvent, Consultingwerk.Framework.IWaitStateManager
Inherited by: Consultingwerk.Framework.NotifyIconWaitStateManager

File:WaitStateManager
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Jun 13 15:49:44 CEST 2009

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ ClearWaitState () Clear wait-state indication
+ ClearWaitState (character) Clear wait-state indication for a specific message
+ ClearWaitState (character, Object) Clear wait-state indication for a specific message from a specific caller
# OnWaitStateChanged (WaitStateChangedEventArgs) Raises the WaitStateChanged event
+ SetWaitState () Indicate a general purpose wait-state to the user
+ SetWaitState (character) Indicate a wait-state with a message to the user. This wait-state will be bouund to a specific caller
+ SetWaitState (character, Object) Indicate a wait-state with a message to the user.

Top Event Summary
Options Name Purpose
+ WaitStateChanged (Object, WaitStateChangedEventArgs) Raised whenever the WaitState changes


Method Detail
Top

PUBLIC ClearWaitState ()
Purpose: Clear wait-state indication
Notes:

Top

PUBLIC ClearWaitState (character)
Purpose: Clear wait-state indication for a specific message
Notes:

Parameters:
pcMessage CHARACTER
The message to clear the wait state for
Top

PUBLIC ClearWaitState (character, Object)
Purpose: Clear wait-state indication for a specific message from a specific
caller
Notes: This is not supported by this class.
ClearWaitState (pcMessage) will call ClearWaitState ()

Parameters:
pcMessage CHARACTER
The message to clear the wait-state for
poCaller Progress.Lang.Object
The reference to the caller
Top

PROTECTED OnWaitStateChanged (WaitStateChangedEventArgs)
Purpose: Raises the WaitStateChanged event
Notes:

Parameters:
e Consultingwerk.Framework.WaitStateChangedEventArgs
The WaitStateChangedEventArgs instance with the data for the event
Top

PUBLIC SetWaitState ()
Purpose: Indicate a general purpose wait-state to the user
Notes:

Top

PUBLIC SetWaitState (character)
Purpose: Indicate a wait-state with a message to the user. This wait-state
will be bouund to a specific caller
Notes: The pcMessage is generally a message code, which will be interpreted
by classes implementing the IWaitStateManager interface
This is not supported by this class.
SetWaitState (pcMessage) will call SetWaitState ()

Parameters:
pcMessage CHARACTER
The message related to the wait state
Top

PUBLIC SetWaitState (character, Object)
Purpose: Indicate a wait-state with a message to the user.
Notes: The pcMessage is generally a message code, which will be interpreted
by classes implementing the IWaitStateManager interface
This is not supported by this class.
SetWaitState (pcMessage, poCaller) will call SetWaitState (pcMessage)

Parameters:
pcMessage CHARACTER
The message related to the wait state
poCaller Progress.Lang.Object
The reference to the caller (currently unused)


Event Detail
Top

PUBLIC WaitStateChanged (Object, WaitStateChangedEventArgs)
Purpose: Raised whenever the WaitState changes
Notes:

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.Framework.WaitStateChangedEventArgs
The WaitStateChangedEventArgs with the data for this event


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