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

MenuItem.GetOffStateImage

Returns the image used to depict the receiver's off state.

Component Version macOS Windows Linux Server iOS SDK
Menu 4.1 ✅ Yes ✅ Yes ❌ No ❌ No ❌ No
MBS( "MenuItem.GetOffStateImage"; item { ; ImageType; FileName } )   More

Parameters

Parameter Description Example Flags
item The reference to the menu item.
Please create one with MenuItem.CreateMenuItem or MenuItem.CreateSeparator.
$item
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.
"test.jpg" Optional

Result

Returns image or error.

Description

Returns the image used to depict the receiver's off state.
The image used to depict the receiver's off state, or empty if the image has not been set.
Please call GMImage.Release later to free memory for this image.

See also

This function checks for a license.

Created 18th August 2014, last changed 29th September 2020


MenuItem.GetMixedStateImage - MenuItem.GetOnStateImage