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

MenuItem.SetState

Sets the state of the menu item.

Component Version macOS Windows Linux Server iOS SDK
Menu 4.1 ✅ Yes ✅ Yes ❌ No ❌ No ❌ No
MBS( "MenuItem.SetState"; item; itemState )   More

Parameters

Parameter Description Example
item The reference to the menu item. Please create one with MenuItem.CreateMenuItem or MenuItem.CreateSeparator. $item
itemState The new state; it should be one of Off, on or mixed. "mixed"

Result

Returns OK or error.

Description

Sets the state of the menu item.
The image associated with the new state is displayed to the left of the menu item.
See also MenuItem.GetState.
Mixed state is not supported on Windows.
On Mac the special values "bullet" and "diamond" sets state to on and switch to use bullet/diamond images.

Examples

Create menu item with mixed state:

Set Variable [$item; Value:MBS("MenuItem.CreateMenuItem"; "With State Mixed")]
Set Variable [$r; Value:MBS("MenuItem.SetState"; $item; "mixed")]
Set Variable [$r; Value:MBS("Menu.AddItem"; $menu; $item)]

Create menu item with on state:

Set Variable [$item; Value:MBS("MenuItem.CreateMenuItem"; "With State On")]
Set Variable [$r; Value:MBS("MenuItem.SetState"; $item; "on")]
Set Variable [$r; Value:MBS("Menu.AddItem"; $menu; $item)]

See also

Example Databases

Blog Entries

This function checks for a license.

Created 18th August 2014, last changed 11st May 2015


MenuItem.SetSelectable - MenuItem.SetStrikeOut