You are here: Charm Setting API

Charm Setting API

The Charms is a feature on Windows 8 which provides access to various application settings such as About, Feedback, and Permissions. The settings can be configured to control an application's access to system capabilities and some specific settings of the current application. To view the Charm settings pane, swipe from the right side of the screen from right to left. For more information about Charm settings, refer Charm Settings.

The Charm Setting API enables you to create a Charm menu, add and remove the Charm menu items.

Important: These functions are supported on Windows 8.0 and Windows 8.1 only.

The Charm Setting API uses kony.application Namespace and the following API elements.

Function	Description
`kony.application.createSettingsMenu`	Enables you to create a Charm settings menu for an application.
`kony.application.setCurrentSettingsMenu`	Uses the unique identifier which represents the Charm settings menu and sets it as current settings menu.
`kony.application.getCurrentSettingsMenu`	Returns the unique identifier of the current menu that is set through getCurrentSettingsMenu.
`kony.application.addSettingsMenuItemAt`	Enables you to add a menu item at a given index in the Charm settings menu.
`kony.application.removeSettingsMenuItemAt`	Enables you to removes the specified App Menu item based on the index.

To create a Charm settings menu for an application, use the kony.application.createSettingsMenu function. You can get the unique identifier of the current menu by using the kony.application.getCurrentSettingsMenu function. With the unique identifier of the Charm menu, you can set the menu as the current settings menu using the kony.application.setCurrentSettingsMenu function.

With this information, you can add a menu item at a given index in the Charm settings menu using the kony.application.addSettingsMenuItemAt function. If you want to delete a menu item from a given index, use the kony.application.removeSettingsMenuItemAt function.