Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

App.SetDockBadgeLabel

Sets the string to be displayed in the tile's badging area.

Component Version macOS Windows Linux Server iOS SDK
App 2.6 ✅ Yes ❌ No ❌ No ❌ No ✅ Yes
MBS( "App.SetDockBadgeLabel"; text )   More

(old name: AppDockTile.setBadgeLabel)

Parameters

Parameter Description Example
text The localized string to display. This string can contain a count value or other badging information. To clear the badge string, specify an empty string "". "123"

Result

Returns OK on success.

Description

Sets the string to be displayed in the tile's badging area.
The appearance of the badge area is system defined.
Available in macOS v10.5 and later.

iOS added in 7.2, but the badge is a number.

Examples

Set and query dock badge:

Set Variable [$r; Value:MBS( "App.SetDockBadgeLabel"; "123" )]
Show Custom Dialog [MBS( "App.GetDockBadgeLabel" )]

Clear it:

MBS( "App.SetDockBadgeLabel"; "" )

See also

Release notes

Blog Entries

This function checks for a license.

Created 18th August 2014, last changed 6th June 2021


App.RequestUserAttention - App.SetDockIcon