icon

Typeproperty
DictionaryLCS
LibraryLiveCode Script
Syntax
set the icon to {<imageID> | <imageName>}
set the icon of {<button> | <stack>} to {<imageID> | <imageName>}
Summary

Specifies an image that is displayed in a button, or used as the desktop icon of a stack file or application.

Introduced1.0
Changes

The order in which LiveCode searches for icons was changed in version 3.5. Previously, the current stack was searched first, followed by the list of open stacks.

OSmac, windows, linux, ios, android
Platformsdesktop, server, mobile
Parameters
NameTypeDescription
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

Example
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"
Values
NameTypeDescription
Value

By default, the icon property is set to zero (no icon). The icon of newly created buttons and stacks is set to zero (no icon) by default.

RelatedProperty: 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
Description

Use the icon property to change a button's 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 systems, a stack's icon is displayed in the dock when the stack is minimized. On Unix systems, the stack's icon is displayed on the desktop when the stack is iconified. Setting a stack's icon property has no effect on Mac OS and Windows systems.

*Cross-platform note:* On OS X systems, the global icon property specifies the current application's dock (glossary) 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 systems.

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 globalproperty, and the icon of a stack had no effect on OS Xsystems.

Tagsfile system