win8_settingscharm_add_html_entry

Adds an option to the "Settings" charm based on an external HTML file for the Windows 8 JavaScript target module.

Syntax:

GML Code Example

win8_settingscharm_add_html_entry(id, name, htmlpath);


Argument Description
id The id (a string) of the new options. This must be the same as the "data-win-options" from the HTML file!
name The name of the option to add to the charm.
htmlpath Full path to the HTML file to use


Returns: N/A


Description

This function is similar to the win8_settingscharm_add_entry only this time you can define your own slide-out menu and options from an external HTML file.

The "id" argument is given as a string and must be exactly the same as the data-win-options specified in the HTML file you are using (there is an example HTML file here). You can then give your new options a name and finally you need to add in the path to get to the HTML file. You can find an example of how the HTML should be formatted from the YoYo Games Knowledge Base article HTML and XAML Examples For The Windows 8 Settings Charm.

NOTE: This function is for the Windows 8 JavaScript target module only. For Windows 8 Native support, please see win8_settingscharm_add_xaml_entry.


Example:

GML Code Example

win8_settingscharm_add_html_entry("defaults", "News", "News.html");

The above code will create a new option within the settings "charm" called "News" which when presses, will open the exported HTML file.





No Examples Submitted

Does this page need better examples? Be the first to Submit

No Edits Suggested

Is this page unclear or not descriptive enough? Suggest an edit to the page and with enough upvotes your changes will be made.

No Questions Have Been Ask

Do you have a question about this page? Ask it Here