ssCore.Popup.setChecked

Enable, disable or toggle the 'checked' state of a menu item.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

name - The name of the menu that contains the item.

id - The ID of the menu item to be modified.

flag - Indicates the new 'checked' state of the menu item. Valid values include: true, false, and toggle.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Popup.setChecked( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Popup.setChecked( paramsObject );


Notes:

None.


Examples:

ssCore.Popup.setChecked({name:"MyContextMenu", id:1, flag:"toggle"});