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

Inherits: Consultingwerk.Framework.WaitStateManager
Implements: Consultingwerk.Framework.IRaisesWaitStateChangedEvent, Consultingwerk.Framework.IWaitStateManager

File:NotifyIconWaitStateManager
Purpose:IWaitStateManager implementation using a NotifyIcon
component
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Jun 13 15:49:44 CEST 2009
Notes:This file is intended for GUI for .NET only

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ ClearWaitState () Clear wait-state indication
Inherited from Consultingwerk.Framework.WaitStateManager
+ ClearWaitState (character) Clear wait-state indication for a specific message
Overrides Consultingwerk.Framework.WaitStateManager:ClearWaitState (character)
+ ClearWaitState (character, Object) Clear wait-state indication for a specific message from a specific caller
Inherited from Consultingwerk.Framework.WaitStateManager
# ContextMenuItemClickHandler (Object, EventArgs) Event handler for the Click event of the notify icons context menu items
# System.Windows.Forms.Form FindCurrentForm () Locates the current form
# NotifyIconDoubleClickHandler (Object, EventArgs) Event handler for the DoubleClick event of the notify icon
# NotifyIconMouseMoveHandler (Object, EventArgs) Event handler for the MouseMove event of the notify icon
# OnWaitStateChanged (WaitStateChangedEventArgs) Raises the WaitStateChanged event
Inherited from Consultingwerk.Framework.WaitStateManager
+ SetWaitState () Indicate a general purpose wait-state to the user
Inherited from Consultingwerk.Framework.WaitStateManager
+ SetWaitState (character) Indicate a wait-state with a message to the user. This wait-state will be bouund to a specific caller
Overrides Consultingwerk.Framework.WaitStateManager:SetWaitState (character)
+ SetWaitState (character, Object) Indicate a wait-state with a message to the user.
Inherited from Consultingwerk.Framework.WaitStateManager

Top Constructor Summary
Options Name Purpose
+ NotifyIconWaitStateManager () Constructor for the NotifyIconWaitStateManager class
+ NotifyIconWaitStateManager (character, character) Constructor for the NotifyIconWaitStateManager class

Top Event Summary
Options Name Purpose
+ WaitStateChanged (Object, WaitStateChangedEventArgs) Raised whenever the WaitState changes
Inherited from Consultingwerk.Framework.WaitStateManager


Method Detail
Top

PUBLIC ClearWaitState ()
Inherited from Consultingwerk.Framework.WaitStateManager
Purpose: Clear wait-state indication
Notes:

Top

PUBLIC ClearWaitState (character)
Overrides Consultingwerk.Framework.WaitStateManager:ClearWaitState (character)
Purpose: Clear wait-state indication for a specific message
Notes: This is not supported by this class.
ClearWaitState (pcMessage) will cal ClearWaitState ()

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

PUBLIC ClearWaitState (character, Object)
Inherited from Consultingwerk.Framework.WaitStateManager
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 ContextMenuItemClickHandler (Object, EventArgs)
Purpose: Event handler for the Click event of the notify icons context menu items
Notes:

Parameters:
sender System.Object
The reference to the sending object
e System.EventArgs
The System.EventArgs with the data for this event
Top

PROTECTED System.Windows.Forms.Form FindCurrentForm ()
Purpose: Locates the current form
Notes: Invoked from the context menu of the notify icon

Returns System.Windows.Forms.Form
The current System.Windows.Forms.Form
Top

PROTECTED NotifyIconDoubleClickHandler (Object, EventArgs)
Purpose: Event handler for the DoubleClick event of the notify icon
Notes: Activates the current main or primary Form

Parameters:
sender System.Object
The reference to the sending object
e System.EventArgs
The System.EventArgs with the data for this event
Top

PROTECTED NotifyIconMouseMoveHandler (Object, EventArgs)
Purpose: Event handler for the MouseMove event of the notify icon
Notes: Sets the text for the notify icon, whne no message is currently shown

Parameters:
sender System.Object
The reference to the sending object
e System.EventArgs
The System.EventArgs with the data for this event
Top

PROTECTED OnWaitStateChanged (WaitStateChangedEventArgs)
Inherited from Consultingwerk.Framework.WaitStateManager
Purpose: Raises the WaitStateChanged event
Notes:

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

PUBLIC SetWaitState ()
Inherited from Consultingwerk.Framework.WaitStateManager
Purpose: Indicate a general purpose wait-state to the user
Notes:

Top

PUBLIC SetWaitState (character)
Overrides Consultingwerk.Framework.WaitStateManager: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)
Inherited from Consultingwerk.Framework.WaitStateManager
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)


Constructor Detail
Top

PUBLIC NotifyIconWaitStateManager ()
Purpose: Constructor for the NotifyIconWaitStateManager class
Notes:

Top

PUBLIC NotifyIconWaitStateManager (character, character)
Purpose: Constructor for the NotifyIconWaitStateManager class
Notes:

Parameters:
pcIdleIconFileName CHARACTER
The file name of the idle icon
pcBusyIconFileName CHARACTER
The file name of the busy icon


Event Detail
Top

PUBLIC WaitStateChanged (Object, WaitStateChangedEventArgs)
Inherited from Consultingwerk.Framework.WaitStateManager
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:28:57