Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5    Statistic  

Window.SetDockImage

Sets the dock image for a window.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
Window 7.5 Yes No No No No

MBS( "Window.SetDockImage"; WindowRef { ; Image } )

Parameters

Parameter Description Example value
WindowRef Window Reference is the unique OS level window ID. You can obtain this by using the Window.FindByTitle or Window.FindByIndex functions. Pass zero to access the frontmost window. 0
Image Optional
The image to use.
Can be container in various formats, e.g. PNG.
If empty, clears existing picture.
$MyImage

Result

Returns OK or error.

Description

Sets the dock image for a window.
The miniaturized window image is the image displayed in the Dock when the window is minimized. If you did not assign a custom image to the window, the value of this property is empty.
When the user minimizes the window, the Dock displays this image in the corresponding Dock tile, scaling it as needed to fit in the tile. If you do not specify a custom image using this property, the Dock creates one for you automatically.
You can also set this property as needed to change the minimized window image. Typically, you would specify a custom image immediately prior to a window being minimized. You can set this image while the window is minimized to update the current image in the Dock. However, you should not use this property to create complex animations in the Dock.
Support for custom images is disabled by default. To enable support the plugin automatically sets the AppleDockIconEnabled key to true when updating the image. Due to this enable process, the function may only work the second time you call it after restarting FileMaker.

Examples

Set image for current window:

Set Variable [ $r ; Value: MBS( "Window.SetDockImage"; 0; Assets::Image) ]

See also


Window.SetCurrentTag   -   Window.SetFullScreenAuxiliary

Feedback: Report problem or ask question.




Links
MBS Xojo Plugins