| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
MenuItem.GetOnStateImage
Returns the image used to depict the receiver's on state.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| Menu | 4.1 | ✅ Yes | ✅ Yes | ❌ No | ❌ No | ❌ No |
MBS( "MenuItem.GetOnStateImage"; 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 on state.The image used to depict the receiver's "on” state, or empty if the image has not been set.
Please call GMImage.Release later to free memory for this image.
See also
- GMImage.Release
- MenuItem.CreateMenuItem
- MenuItem.CreateSeparator
- MenuItem.GetMixedStateImage
- MenuItem.GetOffStateImage
- MenuItem.SetMixedStateImage
- MenuItem.SetOffStateImage
- MenuItem.SetOnStateImage
This function checks for a license.
Created 18th August 2014, last changed 29th September 2020
