Window.ShowBalloonTrayTip Method (Typed) | |
Display a balloon tip for an icon in the tray that is associated with this window.
Namespace:
XSharp.VO.SDK
Assembly:
XSharp.VOGUIClasses (in XSharp.VOGUIClasses.dll) Version: 2.21
Syntax VIRTUAL METHOD ShowBalloonTrayTip(
oTrayIcon AS VOTrayIcon,
dwID AS DWORD,
sHeading AS STRING,
sToolTip AS STRING,
dwTimeOut AS LONG,
dwInfo AS LONG
) AS USUAL
public virtual Usual ShowBalloonTrayTip(
VOTrayIcon oTrayIcon,
[DefaultParameterValueAttribute(1, 0)] uint dwID,
[DefaultParameterValueAttribute("", 0)] string sHeading,
[DefaultParameterValueAttribute("", 0)] string sToolTip,
[DefaultParameterValueAttribute(1000, 0)] int dwTimeOut,
[DefaultParameterValueAttribute(0, 0)] int dwInfo
)
Request Example
View SourceParameters
- oTrayIcon
- Type: VOTrayIcon
The icon to be displayed in the tray. - dwID
- Type: DWord
The unique ID of the icon (between 1 and 8000). - sHeading
- Type: String
The heading to be displayed in the balloon. This title appears in boldface above the text. It can have a maximum of 63 characters. - sToolTip
- Type: String
The text to be displayed in the balloon. In Shell version 5 and above, the maximum size is 128 charecters. Below Shell version 5, the maximum is 64 charecters. - dwTimeOut
- Type: Long
The length of time to display the balloon before it is removed if it is not dismissed by the user.
The system enforces minimum and maximum timeout values. dwTimeout values that are too large are set to the maximum value and values that are too small default to the minimum value.
This is set in milliseconds.
- dwInfo
- Type: Long
Flags that can be set to add an icon to a balloon ToolTip.
Valid values are:
Constant | Description |
---|
NIIF_ERROR
| An error icon. |
NIIF_INFO
| An information icon. |
NIIF_NONE
| No icon. |
NIIF_WARNING
| A warning icon. |
NIIF_NOSOUND
| Do not play the associated sound. |
Return Value
Type:
UsualThe result of the call to Shell_NotifyIcon() (see the WIN32 API)
See Also