Class

DockItem

Description

Used to manage the icons for your application and application windows in the macOS Dock.

Properties

Name	Type	Read-Only	Shared
Graphics	Graphics	✓

Methods

Name	Parameters	Returns	Shared
ResetIcon
UpdateNow

Property descriptions

DockItem.Graphics

Graphics As Graphics

Provides access to all the Graphics class methods for drawing into the dock icon.

This property is read-only.

This code draws an image (that is part of the project) as the DockItem:

App.DockItem.Graphics.DrawPicture(MyDockIcon, 0, 0, 128, 128)
App.DockItem.UpdateNow

Method descriptions

DockItem.ResetIcon

ResetIcon

Resets the icon to its original state, its default appearance, and then draws a new icon.

App.DockItem.ResetIcon
App.DockItem.Graphics.DrawPicture(NewDockIcon, 0, 0, 128, 128)
App.DockItem.UpdateNow

DockItem.UpdateNow

UpdateNow

Redraws the icon.

This code draws an image (that has been added to the project) as the DockItem.

App.DockItem.Graphics.DrawPicture(MyDockIcon, 0, 0, 128, 128)
App.DockItem.UpdateNow

Notes

The DockItem class is only for macOS. It enables you to manipulate the dock item associated with your application or with the application's windows. To manipulate the application's dock icon, use the DockItem property of the DesktopApplication class. To manipulate a window's dock icon, use the DockItem property of the Window class.

Use the methods of the Graphics class to modify the appearance of the icon. Since a macOS icon is intended to be scaled automatically, you should design it as at least a 128x128 pixel icon and perhaps as large as 1024x1024 for newer version of macOS.

The DockItem class has two methods, UpdateNow and ResetIcon. ResetIcon resets the icon to its original state. Call the UpdateNow method to redraw the icon. You can also use the Graphics.ClearRectangle to start over from a blank icon. Anything you can do with a Graphics object you are able to do with the DockItem's Graphics property, such as drawing in a picture or using a Group2D.

The Graphics property may be Nil; it is non-Nil for a window only when a macOS window has been minimized to the dock.

Compatibility

All project types on all supported operating systems.