Namespace: Consultingwerk.Windows.Controls
Class 
NotificationBar Copy to Clipboard
Parent classes:
System.Windows.Forms.Control
Consultingwerk.Windows.Controls.NotificationBar

Inherits: System.Windows.Forms.Control

File:NotificationBar
Purpose:Custom Control that visualizes a notification that is
shown without modality at the top of a Form / Container
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Apr 06 16:46:31 CEST 2013
Notes:Supports MouseClick event and flashing
Inspired by http://www.codeproject.com/Articles/26627/Notification-Bar

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
# DrawCloseButton (PaintEventArgs) Draws the Close Button
# DrawText (PaintEventArgs) Draws the Controls text
+ Flash (integer) Flashes the Control for the given number of times and default interval for each flashing (750 milliseconds)
+ Flash (integer, integer) Flashes the Control for the given number of times and the given interval for each flashing
+ FlashOnce (integer) Flashes the Control onces with for the given number of milliseconds
# FlashTimerTickHandler (Object, EventArgs) Event handler for the Tick event of the FlashTimer
# OnMouseClick (MouseEventArgs) Raises the MouseClick event
# OnMouseEnter (EventArgs) Raises the MouseEnter event
# OnMouseLeave (EventArgs) Raises the MouseLeave event
# OnPaint (PaintEventArgs) Raises the paint event
# OnTextChanged (EventArgs) Raises the TextChanged event
# OnVisibleChanged (EventArgs) Raises the VisibleChanged event

Top Constructor Summary
Options Name Purpose
+ NotificationBar () Constructor for the NotificationBar class

Top Property Summary
Options Name Purpose
+ System.Drawing.Image Image Gets and sets the reference to the Image shown on the Left of the NotificationBar
+ LOGICAL PlaySoundWhenShown Gets and sets if a sound should be played when the Control is shown


Method Detail
Top

PROTECTED DrawCloseButton (PaintEventArgs)
Purpose: Draws the Close Button
Notes:

Parameters:
e System.Windows.Forms.PaintEventArgs
The PaintEventArgs of the Current Paint interaction
Top

PROTECTED DrawText (PaintEventArgs)
Purpose: Draws the Controls text
Notes:

Parameters:
e System.Windows.Forms.PaintEventArgs
The PaintEventArgs of the Current Paint interaction
Top

PUBLIC Flash (integer)
Purpose: Flashes the Control for the given number of times and default interval
for each flashing (750 milliseconds)
Notes:

Parameters:
piNumberOfTimes INTEGER
The number of times the Control is supposed to flash
Top

PUBLIC Flash (integer, integer)
Purpose: Flashes the Control for the given number of times and the given interval
for each flashing
Notes:

Parameters:
piInterval INTEGER
The interval in milliseconds used for flashing
piNumberOfTimes INTEGER
The number of times the Control is supposed to flash
Top

PUBLIC FlashOnce (integer)
Purpose: Flashes the Control onces with for the given number of milliseconds
Notes:

Parameters:
piInterval INTEGER
The interval in milliseconds used for flashing
Top

PROTECTED FlashTimerTickHandler (Object, EventArgs)
Purpose: Event handler for the Tick event of the FlashTimer
Notes:

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

PROTECTED OnMouseClick (MouseEventArgs)
Purpose: Raises the MouseClick event
Notes:

Parameters:
e System.Windows.Forms.MouseEventArgs
The MouseEventArgs with the data for this event
Top

PROTECTED OnMouseEnter (EventArgs)
Purpose: Raises the MouseEnter event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for this event
Top

PROTECTED OnMouseLeave (EventArgs)
Purpose: Raises the MouseLeave event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for this event
Top

PROTECTED OnPaint (PaintEventArgs)
Purpose: Raises the paint event
Notes:

Parameters:
e System.Windows.Forms.PaintEventArgs
The PaintEventArgs with the data for this event
Top

PROTECTED OnTextChanged (EventArgs)
Purpose: Raises the TextChanged event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for this event
Top

PROTECTED OnVisibleChanged (EventArgs)
Purpose: Raises the VisibleChanged event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for this event


Constructor Detail
Top

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



Property Detail
Top

PUBLIC System.Drawing.Image Image
Purpose: Gets and sets the reference to the Image shown on the Left of the
NotificationBar
Notes:

Returns System.Drawing.Image
Top

PUBLIC LOGICAL PlaySoundWhenShown
Purpose: Gets and sets if a sound should be played when the Control is shown
Notes:

Returns LOGICAL


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