SysIconAdd (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Functions for Windows management

Mouse (or stylus) operation on the icon

Icon in the taskbar

See also

SysIconAdd (Function)

In french: SysIconeAjoute

Adds an icon into the taskbar (bottom right corner of screen).

The following elements can be associated with this icon:

a popup menu,
a message when the icon is hovered by the mouse (or by the stylus),
a procedure automatically called when an operation is performed on the icon by the mouse (or by the stylus).

In order for the icon to be visible, the current windows must not be maximized. Otherwise, the icon will never be displayed.

Special case: In Smartphone: The icon is displayed in the top right corner of the screen. The current windows can be maximized. No custom popup menu, rollover message or procedure can be associated with this icon.

Example

See additional examples

// Add the "C:\Icons\Icon.ICO" icon into the taskbar
ResAddIcon = SysIconAdd("C:\Icons\Icon.ICO", "", "Sales 2013")

// Add the "\Icons\Icon.ICO" icon into the taskbar
ResAddIcon = SysIconAdd("\Icons\Icon.ICO", "", "Sales 2013")

Versions 21 and later

pProc is Procedure = MyProc
SysIconAdd(fExeDir() + "\icon.ico", MENU_NoName1, "Message", pProc)

New in version 21

pProc is Procedure = MyProc
SysIconAdd(fExeDir() + "\icon.ico", MENU_NoName1, "Message", pProc)

Syntax

<Result> = SysIconAdd(<Icon> [, <Menu name> [, <Rollover message> [, <Procedure name>]]])

<Result>: Boolean

True if the icon was added,
False otherwise.

<Icon>: Character string (between quotes) or Icon variable

Corresponds to one of the following elements:
Name and full (or relative) path of the icon file to add. A UNC path is allowed.
No relative path or UNC path can be used.
Versions 20 and later
Name of Icon variable.
New in version 20
Name of Icon variable.
Name of Icon variable.
Remark: The first valid image (other than PNG) found in the icon file is used and adapted to the 16x16 format. If the icon file contains in first position an image in 16x16 / 32 bpp, the quality of the icon will be very high. If the icon file contains in first position an image in 48x48 / 32 bpp, the quality of the icon will be very poor.

<Menu name>: Optional character string (with quotes)

Name of the popup menu associated with the icon.
If this parameter corresponds to an empty string ("") or if it is not specified, no menu will be associated with the icon.
This menu will be displayed when a right click is performed on the icon by the mouse (or by the stylus). This menu must belong to an opened window (this window can be hidden).
This parameter is ignored on Smartphone.

<Rollover message>: Optional character string (with quotes)

Message displayed when the icon is hovered by the mouse cursor or by the stylus (up to 64 characters).
If this parameter is not specified or if it is an empty string (""), no rollover message is displayed.
This parameter is taken into account only if icon rollover is supported by the device used. This parameter is ignored on Smartphone.

<Procedure name>: Optional character string (with or without quotes)

Name of the WLanguage procedure called during a mouse (or stylus) operation on the icon. If this parameter is not specified, no procedure will be run during a mouse operation on the icon.
This parameter is ignored on Smartphone.
Remark: This parameter can correspond to a Procedure variable.

Remarks

Mouse (or stylus) operation on the icon

<Procedure name> is called whenever a mouse (or stylus) operation is performed on the icon. This procedure is declared as follows:

PROCEDURE <Procedure name>(<Type of mouse/stylus operation>)

where <Type of mouse/stylus operation> corresponds to the Windows message identifying the type of operation performed by the mouse or stylus.

To easily manage the constants corresponding to the different types of operation, insert the following code in the initialization code of the project:

EXTERN "WinConst.wl"

The Winconst.wl file contains all the declarations of the Windows constants.

The different types of operations for the mouse are:

Left double click: WM_LBUTTONDBLCLK = 515
Left button down: WM_LBUTTONDOWN = 513
Left button up: WM_LBUTTONUP = 514
Middle double click: WM_MBUTTONDBLCLK = 521
Middle button down: WM_MBUTTONDOWN = 519
Middle button up: WM_MBUTTONUP = 520
Right double click: WM_RBUTTONDBLCLK = 518
Right button down: WM_RBUTTONDOWN = 516
Right button up: WM_RBUTTONUP = 517

The different types of operations for the stylus are:

Double click: WM_LBUTTONDBLCLK = 515
Button down: WM_LBUTTONDOWN = 513
Button up: WM_LBUTTONUP = 514

Icon in the taskbar

A single icon can be added into an application. You cannot add several ones.
SysIconModify is used to modify the icon.
SysIconDelete is used to delete the icon. The icon is automatically deleted when closing the application.
To add the icon into the taskbar without displaying the application in the taskbar, you must:
- Use SysIconAdd to display the icon of the application.
- Make the application invisible by applying WinStatus to the first project window.

Business / UI classification : Business Logic

Component : wd250std.dll