using System; using System.ComponentModel; using System.Diagnostics; using System.Threading; using System.Windows; using System.Windows.Controls; using Hardcodet.Wpf.TaskbarNotification.Interop; namespace Hardcodet.Wpf.TaskbarNotification { /// /// A WPF proxy to for a taskbar icon (NotifyIcon) that sits in the system's /// taskbar notification area ("system tray"). /// public partial class TaskbarIcon : FrameworkElement, IDisposable { /// /// Represents the current icon data. /// private NotifyIconData iconData; /// /// Receives messages from the taskbar icon. /// private readonly WindowMessageSink messageSink; /// /// Indicates whether the taskbar icon has been created or not. /// public bool IsTaskbarIconCreated { get; set; } /// /// Indicates whether custom tooltips are supported, which depends /// on the OS. Windows Vista or higher is required in order to /// support this feature. /// public bool SupportsCustomToolTips { get { return messageSink.Version == NotifyIconVersion.Vista; } } /// /// Inits the taskbar icon and registers a message listener /// in order to receive events from the taskbar area. /// public TaskbarIcon() { //do nothing if in design mode if (Util.IsDesignMode) { messageSink = WindowMessageSink.CreateEmpty(); } else { //create message sink that receives window messages messageSink = new WindowMessageSink(NotifyIconVersion.Win95); } //init icon data structure iconData = NotifyIconData.CreateDefault(messageSink.MessageWindowHandle); //create the taskbar icon CreateTaskbarIcon(); //register event listeners messageSink.MouseEventReceived += OnMouseEvent; messageSink.TaskbarCreated += OnTaskbarCreated; messageSink.ChangeToolTipStateRequest += OnToolTipChange; messageSink.BallonToolTipChanged += OnBalloonToolTipChanged; //init single click timer singleClickTimer = new Timer(DoSingleClickAction); //register listener in order to get notified when the application closes if (Application.Current != null) Application.Current.Exit += OnExit; } /// /// Processes mouse events, which are bubbled /// through the class' routed events, trigger /// certain actions (e.g. show a popup), or /// both. /// /// Event flag. private void OnMouseEvent(MouseEvent me) { if (IsDisposed) return; switch(me) { case MouseEvent.MouseMove: RaiseTaskbarIconMouseMoveEvent(); break; case MouseEvent.IconRightMouseDown: RaiseTaskbarIconRightMouseDownEvent(); break; case MouseEvent.IconLeftMouseDown: RaiseTaskbarIconLeftMouseDownEvent(); break; case MouseEvent.IconRightMouseUp: RaiseTaskbarIconRightMouseUpEvent(); break; case MouseEvent.IconLeftMouseUp: RaiseTaskbarIconLeftMouseUpEvent(); break; case MouseEvent.IconMiddleMouseDown: RaiseTaskbarIconMiddleMouseDownEvent(); break; case MouseEvent.IconMiddleMouseUp: RaiseTaskbarIconMiddleMouseUpEvent(); break; case MouseEvent.IconDoubleClick: //cancel single click timer singleClickTimer.Change(Timeout.Infinite, Timeout.Infinite); //bubble event RaiseTaskbarIconMouseDoubleClickEvent(); break; case MouseEvent.BalloonToolTipClicked: RaiseTaskbarIconBalloonTipClickedEvent(); break; default: throw new ArgumentOutOfRangeException("me", "Missing handler for mouse event flag: " + me); } //show popup, if requested if (me.IsMatch(PopupActivation)) { if (me == MouseEvent.IconLeftMouseUp) { //show popup once we are sure it's not a double click delayedTimerAction = ShowTrayPopup; singleClickTimer.Change(WinApi.GetDoubleClickTime(), Timeout.Infinite); } else { //show popup immediately ShowTrayPopup(); } } //show context menu, if requested if (me.IsMatch(MenuActivation)) { if (me == MouseEvent.IconLeftMouseUp) { //show context menu once we are sure it's not a double click delayedTimerAction = ShowContextMenu; singleClickTimer.Change(WinApi.GetDoubleClickTime(), Timeout.Infinite); } else { //show context menu immediately ShowContextMenu(); } } } /// /// Displays a custom tooltip, if available. This functionality /// is only available for Windows Vista and above. /// /// Whether to show or hide the tooltip. private void OnToolTipChange(bool visible) { //if we have a custom tooltip, show it now if (ToolTip == null) return; ToolTip tt = (ToolTip)ToolTip; if (visible) { var args = RaisePreviewTaskbarIconToolTipOpenEvent(); if (args.Handled) return; tt.IsOpen = true; RaiseTaskbarIconToolTipOpenEvent(); } else { var args = RaisePreviewTaskbarIconToolTipCloseEvent(); if (args.Handled) return; tt.IsOpen = false; RaiseTaskbarIconToolTipCloseEvent(); } } /// /// Bubbles events if a balloon ToolTip was displayed /// or removed. /// /// Whether the ToolTip was just displayed /// or removed. private void OnBalloonToolTipChanged(bool visible) { if (visible) { RaiseTaskbarIconBalloonTipShownEvent(); } else { RaiseTaskbarIconBalloonTipClosedEvent(); } } #region SetVersion /// /// Sets the version flag for the . /// private void SetVersion() { iconData.VersionOrTimeout = (uint)NotifyIconVersion.Vista; bool status = WinApi.Shell_NotifyIcon(NotifyCommand.SetVersion, ref iconData); if (!status) { iconData.VersionOrTimeout = (uint)NotifyIconVersion.Win2000; status = Util.WriteIconData(ref iconData, NotifyCommand.SetVersion); } if (!status) { iconData.VersionOrTimeout = (uint)NotifyIconVersion.Win95; status = Util.WriteIconData(ref iconData, NotifyCommand.SetVersion); } if (!status) { Debug.Fail("Could not set version"); } } #endregion #region Create / Remove Taskbar Icon /// /// Recreates the taskbar icon if the whole taskbar was /// recreated (e.g. because Explorer was shut down). /// private void OnTaskbarCreated() { IsTaskbarIconCreated = false; CreateTaskbarIcon(); } /// /// Creates the taskbar icon. This message is invoked during initialization, /// if the taskbar is restarted, and whenever the icon is displayed. /// private void CreateTaskbarIcon() { lock (this) { if (!IsTaskbarIconCreated) { const IconDataMembers members = IconDataMembers.Message | IconDataMembers.Icon | IconDataMembers.Tip; //write initial configuration var status = Util.WriteIconData(ref iconData, NotifyCommand.Add, members); if (!status) { throw new Win32Exception("Could not create icon data"); } //set to most recent version SetVersion(); messageSink.Version = (NotifyIconVersion) iconData.VersionOrTimeout; IsTaskbarIconCreated = true; } } } /// /// Closes the taskbar icon if required. /// private void RemoveTaskbarIcon() { lock (this) { if (IsTaskbarIconCreated) { Util.WriteIconData(ref iconData, NotifyCommand.Delete, IconDataMembers.Message); IsTaskbarIconCreated = false; } } } #endregion #region Dispose / Exit /// /// Set to true as soon as /// has been invoked. /// public bool IsDisposed { get; private set; } /// /// Checks if the object has been disposed and /// raises a in case /// the flag is true. /// private void EnsureNotDisposed() { if (IsDisposed) throw new ObjectDisposedException(Name ?? GetType().FullName); } /// /// Disposes the class if the application exits. /// private void OnExit(object sender, EventArgs e) { Dispose(); } /// /// This destructor will run only if the /// method does not get called. This gives this base class the /// opportunity to finalize. /// /// Important: Do not provide destructors in types derived from /// this class. /// /// ~TaskbarIcon() { Dispose(false); } /// /// Disposes the object. /// /// This method is not virtual by design. Derived classes /// should override . /// public void Dispose() { Dispose(true); // This object will be cleaned up by the Dispose method. // Therefore, you should call GC.SupressFinalize to // take this object off the finalization queue // and prevent finalization code for this object // from executing a second time. GC.SuppressFinalize(this); } /// /// Closes the tray and releases all resources. /// /// /// Dispose(bool disposing) executes in two distinct scenarios. /// If disposing equals true, the method has been called directly /// or indirectly by a user's code. Managed and unmanaged resources /// can be disposed. /// /// If disposing equals false, the method /// has been called by the runtime from inside the finalizer and you /// should not reference other objects. Only unmanaged resources can /// be disposed. /// Check the property to determine whether /// the method has already been called. private void Dispose(bool disposing) { //don't do anything if the component is already disposed if (IsDisposed || !disposing) return; lock (this) { IsDisposed = true; //deregister application event listener Application.Current.Exit -= OnExit; //stop timer singleClickTimer.Dispose(); //dispose message sink messageSink.Dispose(); RemoveTaskbarIcon(); } } #endregion } }