Struct NotifyIconData
A struct that is submitted in order to configure the taskbar icon. Provides various members that can be configured partially, according to the values of the IconDataMembers that were defined.
Inherited Members
Namespace: Simplic.Framework.Core.TaskbarNotification.Interop
Assembly: Simplic.Framework.Base.dll
Syntax
public struct NotifyIconData
Fields
| Improve this Doc View SourceBalloonFlags
Adds an icon to a balloon ToolTip, which is placed to the left of the title. If the BalloonTitle member is zero-length, the icon is not shown.
Declaration
public BalloonFlags BalloonFlags
Field Value
Type | Description |
---|---|
BalloonFlags |
BalloonText
String with the text for a balloon ToolTip. It can have a maximum of 255 characters. To remove the ToolTip, set the NIF_INFO flag in uFlags and set szInfo to an empty string.
Declaration
public string BalloonText
Field Value
Type | Description |
---|---|
System.String |
BalloonTitle
String containing a title for a balloon ToolTip. This title appears in boldface above the text. It can have a maximum of 63 characters.
Declaration
public string BalloonTitle
Field Value
Type | Description |
---|---|
System.String |
CallbackMessageId
Application-defined message identifier. The system uses this identifier to send notifications to the window identified in hWnd.
Declaration
public uint CallbackMessageId
Field Value
Type | Description |
---|---|
System.UInt32 |
cbSize
Size of this structure, in bytes.
Declaration
public uint cbSize
Field Value
Type | Description |
---|---|
System.UInt32 |
CustomBalloonIconHandle
Windows Vista (Shell32.dll version 6.0.6) and later. The handle of a customized
balloon icon provided by the application that should be used independently
of the tray icon. If this member is non-NULL and the User
flag is set, this icon is used as the balloon icon.
If this member is NULL, the legacy behavior is carried out.
Declaration
public IntPtr CustomBalloonIconHandle
Field Value
Type | Description |
---|---|
System.IntPtr |
IconHandle
A handle to the icon that should be displayed. Just
Icon.Handle
.
Declaration
public IntPtr IconHandle
Field Value
Type | Description |
---|---|
System.IntPtr |
IconState
State of the icon. Remember to also set the StateMask.
Declaration
public IconState IconState
Field Value
Type | Description |
---|---|
IconState |
StateMask
A value that specifies which bits of the state member are retrieved or modified. For example, setting this member to Hidden causes only the item's hidden state to be retrieved.
Declaration
public IconState StateMask
Field Value
Type | Description |
---|---|
IconState |
TaskbarIconGuid
Windows XP (Shell32.dll version 6.0) and later.
- Windows 7 and later: A registered GUID that identifies the icon.
This value overrides uID and is the recommended method of identifying the icon.
- Windows XP through Windows Vista: Reserved.
Declaration
public Guid TaskbarIconGuid
Field Value
Type | Description |
---|---|
System.Guid |
TaskbarIconId
Application-defined identifier of the taskbar icon. The Shell uses hWnd and uID to identify which icon to operate on when Shell_NotifyIcon is invoked. You can have multiple icons associated with a single hWnd by assigning each a different uID. This feature, however is currently not used.
Declaration
public uint TaskbarIconId
Field Value
Type | Description |
---|---|
System.UInt32 |
ToolTipText
String with the text for a standard ToolTip. It can have a maximum of 64 characters including the terminating NULL. For Version 5.0 and later, szTip can have a maximum of 128 characters, including the terminating NULL.
Declaration
public string ToolTipText
Field Value
Type | Description |
---|---|
System.String |
ValidMembers
Flags that indicate which of the other members contain valid data. This member can be a combination of the NIF_XXX constants.
Declaration
public IconDataMembers ValidMembers
Field Value
Type | Description |
---|---|
IconDataMembers |
VersionOrTimeout
Mainly used to set the version when Simplic.Framework.Core.TaskbarNotification.Interop.WinApi.Shell_NotifyIcon(Simplic.Framework.Core.TaskbarNotification.Interop.NotifyCommand,Simplic.Framework.Core.TaskbarNotification.Interop.NotifyIconData@) is invoked with SetVersion. However, for legacy operations, the same member is also used to set timouts for balloon ToolTips.
Declaration
public uint VersionOrTimeout
Field Value
Type | Description |
---|---|
System.UInt32 |
WindowHandle
Handle to the window that receives notification messages associated with an icon in the taskbar status area. The Shell uses hWnd and uID to identify which icon to operate on when Shell_NotifyIcon is invoked.
Declaration
public IntPtr WindowHandle
Field Value
Type | Description |
---|---|
System.IntPtr |
Methods
| Improve this Doc View SourceCreateDefault(IntPtr)
Creates a default data structure that provides a hidden taskbar icon without the icon being set.
Declaration
public static NotifyIconData CreateDefault(IntPtr handle)
Parameters
Type | Name | Description |
---|---|---|
System.IntPtr | handle |
Returns
Type | Description |
---|---|
NotifyIconData |