Specifies an image that is displayed in a button, or used as the desktop icon of a stack file or application.
# Metadata
Platforms: desktop, server, mobile OS: mac, windows, linux, ios, android Introduced: 1.0 Security:
# Syntax
set the icon to {imageID | imageName}
# Params
- imageID : The id of the image to use for the button or stack icon or current application's dock icon - imageName : The short name of the image to use for the button or stack icon or current application's dock icon
# Examples
set the icon of this stack to kStackIcon
set the icon of button "Help" to "Question Mark"
set the icon to the myAppIcon of stack "Main Settings"
# Description
Use the icon property to change a button appearance, or to set the icon used for a stack or application in the OS X dock.
LiveCode looks for the specified image in the following order:
* 1. The stack of the object's behavior (if applicable) * 2. The stack of the owner of the object's behavior (if applicable) * ... * n. The stack of the object's stack's behavior (if applicable) * A. The object's stack * B. The object's stack's mainstack (if a substack) * C. The object's stack's mainstack's substacks * D. The list of open stacks, in order they were loaded
If a button has been clicked during the current session and its visitedIcon property is set, its visitedIcon is displayed instead of its icon. If the button is disabled and its disabledIcon property is set, its disabledIcon is displayed instead of its icon.
>*Cross-platform note:* On OS X, a stack > icon is displayed in the dock when the stack is minimized. On > Unix, the stack icon is displayed on the > desktop when the stack is iconify. Setting a > stack icon property has no effect on Mac OS and > Windows.
>*Cross-platform note:* On OS X systems, the global icon property > specifies the current application's dock icon. The > engine will attempt to find an image with the given id, resize it to > 128x128 and then set it as the dock icon for the application. The > setting of the global icon property has no effect on Mac OS, > Unix, or Windows.
>*Note:* The image is only guaranteed to persist while the application > runs, although in some cases the OS does appear to cache it beyond > this.
The ability to specify an icon for an application or stack file on OS X systems was added in version 2.1. In previous versions, the icon was a button and stack property but not a global, and the icon of a stack had no effect on OS X.
# Tags
# See
- **property:** visitedIcon, hilitedIcon, icon, behavior, armedIcon, disabledIcon - **message:** iconifyStack - **keyword:** default, image, button - **glossary:** property, OS X, global, stack file, dock, desktop, Windows, Mac OS, Unix, iconify, application - **function:** stacks - **command:** global - **object:** stack, button