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

Window.Screenshot

Creates screenshot from a window.

Component Version macOS Windows Linux Server iOS SDK
Window 5.4 ✅ Yes ✅ Yes ❌ No ❌ No ✅ Yes
MBS( "Window.Screenshot"; WindowRef { ; MarginLeft; MarginTop; MarginRight; MarginBottom; ImageType; Filename } )   More

Parameters

Parameter Description Example Flags
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
MarginLeft The margin from left to cut away border. 0 Optional
MarginTop The margin from top to cut away border. 0 Optional
MarginRight The margin from right to cut away border. 0 Optional
MarginBottom The margin from bottom to cut away border. 0 Optional
ImageType The type of image to return.
Either JPEG, PNG, GIF or BMP. Default is JPEG.
"JPEG" Optional
Filename The filename to use for the picture.
Default is "image" with the extension matching the image type.
The image is not written to disk. This file name is just added to the container for later export.
"test.jpg" Optional

Result

Returns image or error.

Description

Creates screenshot from a window.
Returns the image as container value, so you can assign it to a container field or save to disk with Container.WriteFile function.
Margins are different for Mac and Windows.

Added iOS support in version 8.5, but margins are not supported there, so we always take full screen.

On Windows may get wrong rectangle if Windows runs desktop with 200% resolution, but you have a 100% resolution screen.
If you change zoom in Windows display controls while FileMaker runs, the plugin may not notice the change until you restart FileMaker.

Examples

Creates screenshot:

MBS("Window.Screenshot"; Get(WindowName); Window Screenshot::Margin Left; Window Screenshot::Margin Top; Window Screenshot::Margin Right; Window Screenshot::Margin Bottom)

Screenshot of current window as JPEG:

MBS( "Window.Screenshot"; 0)

See also

Release notes

Example Databases

Blog Entries

This function checks for a license.

Created 27th October 2015, last changed 23th September 2021


Window.RunToolbarCustomizationPalette - Window.Scrollbar.GetScrollElasticity