|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Visual Basic Subclassing Routines Shell_NotifyIcon: Display Systray Balloon Tips |
||
Posted: | Sunday July 07, 2002 | |
Updated: | Monday December 26, 2011 | |
Applies to: | VB5, VB6 | |
Developed with: | VB6, Windows XP | |
OS restrictions: | Windows 2000 or Windows XP | |
Author: | VBnet - Randy Birch | |
Related: |
CreateWindowEx: 21st Century ToolTips for VB - The Basics Shell_NotifyIcon: Windows Systray NOTIFYICONDATA Overview Shell_NotifyIcon: Add Icon to Windows System Tray Shell_NotifyIcon: Respond to Systray Icon/Menu Interaction Shell_NotifyIcon: Respond to Systray Icon/Menu Interaction in a MDI App Shell_NotifyIcon: Animate the System Tray Icon Shell_NotifyIcon: Display Systray Balloon Tips Shell_NotifyIcon: Respond to Systray Balloon Tip Clicks Shell_NotifyIcon: Use SetTimer to Define Balloon Tip Life SendMessage: Add Balloon Tips to a Combo Edit Box SendMessage: Add Balloon Tips to a Text Box |
|
Prerequisites |
Windows 2000 or XP (Shell version 5 or better). This demo contains new code added January 2003 to properly determine the Shell32.dll version and use the appropriately-sized NOTIFYICONDATA structure. Although this will handle the display of the systray icon across Windows versions, application designers targeting Windows 2000 and XP should nonetheless take appropriate steps to ensure their app degrades gracefully to utilize only the functionality provided in earlier system's shell versions. For information concerning using the systray across all Windows versions it is strongly recommended you refer to Shell_NotifyIcon: Windows Systray NOTIFYICONDATA Overview. |
|
Here's
the minimum code to present a balloon tip that emanates from a systray
icon. Rather than paraphrase the rather elaborate details provided in the
MSDN regarding the updated NOTIFYICONDATA structure available to Windows
2000 and Windows XP users, I have opted instead to present its entire
discussion. See
Shell_NotifyIcon: Windows Systray NOTIFYICONDATA Overview One point should be noted: The new type uses a Union which is not supported in VB. Hence, in my definition of the structure, the Union variables uTimeout and uVersion are represented as a single Long. Note also that, unlike the other Shell_Notify examples on VBnet, this sample is not subclassed, and so does not respond to clicks on the systray icon. This is intentional to demonstrate as simply as possible the new features, which can then be added to your existing subclassed Shell_Notify code. |
BAS Module |
None. |
|
Form Code |
To a form add a text box (Text1, multiline), four option buttons in a control array (Option1(0) through Option1(3)), and two command buttons (Command1, Command2), with the following code: |
|
Option Explicit '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' ' Copyright ©1996-2011 VBnet/Randy Birch, All Rights Reserved. ' Some pages may also contain other copyrights by the author. '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' ' Distribution: You can freely use this code in your own ' applications, but you may not reproduce ' or publish this code on any web site, ' online service, or distribute as source ' on any media without express permission. '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' Private Const APP_SYSTRAY_ID = 999 'unique identifier Private Const NOTIFYICON_VERSION = &H3 Private Const NIF_MESSAGE = &H1 Private Const NIF_ICON = &H2 Private Const NIF_TIP = &H4 Private Const NIF_STATE = &H8 Private Const NIF_INFO = &H10 Private Const NIM_ADD = &H0 Private Const NIM_MODIFY = &H1 Private Const NIM_DELETE = &H2 Private Const NIM_SETFOCUS = &H3 Private Const NIM_SETVERSION = &H4 Private Const NIM_VERSION = &H5 Private Const NIS_HIDDEN = &H1 Private Const NIS_SHAREDICON = &H2 'icon flags Private Const NIIF_NONE = &H0 Private Const NIIF_INFO = &H1 Private Const NIIF_WARNING = &H2 Private Const NIIF_ERROR = &H3 Private Const NIIF_GUID = &H5 Private Const NIIF_ICON_MASK = &HF Private Const NIIF_NOSOUND = &H10 Private Const WM_USER = &H400 Private Const NIN_BALLOONSHOW = (WM_USER + 2) Private Const NIN_BALLOONHIDE = (WM_USER + 3) Private Const NIN_BALLOONTIMEOUT = (WM_USER + 4) Private Const NIN_BALLOONUSERCLICK = (WM_USER + 5) 'shell version / NOTIFIYICONDATA struct size constants Private Const NOTIFYICONDATA_V1_SIZE As Long = 88 'pre-5.0 structure size Private Const NOTIFYICONDATA_V2_SIZE As Long = 488 'pre-6.0 structure size Private Const NOTIFYICONDATA_V3_SIZE As Long = 504 '6.0+ structure size Private NOTIFYICONDATA_SIZE As Long Private Type GUID Data1 As Long Data2 As Integer Data3 As Integer Data4(7) As Byte End Type Private Type NOTIFYICONDATA cbSize As Long hWnd As Long uID As Long uFlags As Long uCallbackMessage As Long hIcon As Long szTip As String * 128 dwState As Long dwStateMask As Long szInfo As String * 256 uTimeoutAndVersion As Long szInfoTitle As String * 64 dwInfoFlags As Long guidItem As GUID End Type Private Declare Function Shell_NotifyIcon Lib "shell32.dll" _ Alias "Shell_NotifyIconA" _ (ByVal dwMessage As Long, _ lpData As NOTIFYICONDATA) As Long Private Declare Function GetFileVersionInfoSize Lib "version.dll" _ Alias "GetFileVersionInfoSizeA" _ (ByVal lptstrFilename As String, _ lpdwHandle As Long) As Long Private Declare Function GetFileVersionInfo Lib "version.dll" _ Alias "GetFileVersionInfoA" _ (ByVal lptstrFilename As String, _ ByVal dwHandle As Long, _ ByVal dwLen As Long, _ lpData As Any) As Long Private Declare Function VerQueryValue Lib "version.dll" _ Alias "VerQueryValueA" _ (pBlock As Any, _ ByVal lpSubBlock As String, _ lpBuffer As Any, _ nVerSize As Long) As Long Private Declare Sub CopyMemory Lib "kernel32" _ Alias "RtlMoveMemory" _ (Destination As Any, _ Source As Any, _ ByVal Length As Long) Private Sub Form_Load() Text1.Text = "A newer version of MyApp.exe is " & _ "now available for download from " & _ "http://www.somplace.com/myapp/update/." Command1.Caption = "Add Systray Icon" Command2.Caption = "Show Balloon Tip" Command2.Enabled = False Option1(0).Caption = "no icon" Option1(1).Caption = "information icon" Option1(2).Caption = "warning icon" Option1(3).Caption = "error icon" Option1(1).Value = True End Sub Private Sub Form_Unload(Cancel As Integer) ShellTrayRemove End Sub Private Sub Command1_Click() Call ShellTrayAdd Command2.Enabled = True End Sub Private Sub Command2_Click() ShellTrayModifyTip GetSelectedOptionIndex() End Sub Private Sub ShellTrayAdd() Dim nid As NOTIFYICONDATA If NOTIFYICONDATA_SIZE = 0 Then SetShellVersion 'set up the type members With nid .cbSize = NOTIFYICONDATA_SIZE .hWnd = Form1.hWnd .uID = APP_SYSTRAY_ID .uFlags = NIF_MESSAGE Or NIF_ICON Or NIF_TIP .dwState = NIS_SHAREDICON .hIcon = Form1.Icon 'szTip is the tooltip shown when the 'mouse hovers over the systray icon. 'Terminate it since the strings are 'fixed-length in NOTIFYICONDATA .szTip = "New Download Watcher" & vbNullChar .uTimeoutAndVersion = NOTIFYICON_VERSION End With 'add the icon ... Call Shell_NotifyIcon(NIM_ADD, nid) '... and inform the system of the 'NOTIFYICON version in use Call Shell_NotifyIcon(NIM_SETVERSION, nid) End Sub Private Sub ShellTrayRemove() Dim nid As NOTIFYICONDATA If NOTIFYICONDATA_SIZE = 0 Then SetShellVersion With nid .cbSize = NOTIFYICONDATA_SIZE .hWnd = Form1.hWnd .uID = APP_SYSTRAY_ID End With Call Shell_NotifyIcon(NIM_DELETE, nid) End Sub Private Sub ShellTrayModifyTip(nIconIndex As Long) Dim nid As NOTIFYICONDATA If NOTIFYICONDATA_SIZE = 0 Then SetShellVersion With nid .cbSize = NOTIFYICONDATA_SIZE .hWnd = Form1.hWnd .uID = APP_SYSTRAY_ID .uFlags = NIF_INFO .dwInfoFlags = nIconIndex 'InfoTitle is the balloon tip title, 'and szInfo is the message displayed. 'Terminating both with vbNullChar prevents 'the display of the unused padding in the 'strings defined as fixed-length in NOTIFYICONDATA. .szInfoTitle = "New Download Available!" & vbNullChar .szInfo = Text1.Text & vbNullChar End With Call Shell_NotifyIcon(NIM_MODIFY, nid) End Sub Private Sub SetShellVersion() Select Case True Case IsShellVersion(6) NOTIFYICONDATA_SIZE = NOTIFYICONDATA_V3_SIZE '6.0+ structure size Case IsShellVersion(5) NOTIFYICONDATA_SIZE = NOTIFYICONDATA_V2_SIZE 'pre-6.0 structure size Case Else NOTIFYICONDATA_SIZE = NOTIFYICONDATA_V1_SIZE 'pre-5.0 structure size End Select End Sub Private Function IsShellVersion(ByVal version As Long) As Boolean 'returns True if the Shell version '(shell32.dll) is equal or later than 'the value passed as 'version' Dim nBufferSize As Long Dim nUnused As Long Dim lpBuffer As Long Dim nVerMajor As Integer Dim bBuffer() As Byte Const sDLLFile As String = "shell32.dll" nBufferSize = GetFileVersionInfoSize(sDLLFile, nUnused) If nBufferSize > 0 Then ReDim bBuffer(nBufferSize - 1) As Byte Call GetFileVersionInfo(sDLLFile, 0&, nBufferSize, bBuffer(0)) If VerQueryValue(bBuffer(0), "\", lpBuffer, nUnused) = 1 Then CopyMemory nVerMajor, ByVal lpBuffer + 10, 2 IsShellVersion = nVerMajor >= version End If 'VerQueryValue End If 'nBufferSize End Function Private Function GetSelectedOptionIndex() As Long 'returns the selected item index from 'an option button array. Use in place 'of multiple If...Then statements! 'If your array contains more elements, 'just append them to the test condition, 'setting the multiplier to the button's 'negative -index. GetSelectedOptionIndex = Option1(0).Value * 0 Or _ Option1(1).Value * -1 Or _ Option1(2).Value * -2 Or _ Option1(3).Value * -3 End Function |
Comments |
Also see: Shell_NotifyIcon: Respond to Systray Balloon Tip Clicks |
|
|
|
|||||
|
|||||
|
|||||
Copyright ©1996-2011 VBnet and Randy Birch. All Rights Reserved. |