System.Gadget.settingsUI property

[The Windows Gadget Platform/Sidebar is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. ]

Gets or sets the HTML filename for the gadget Settings dialog UI.

This property is read/write.

Syntax

strsettingsUI = System.Gadget.settingsUI
System.Gadget.settingsUI = strsettingsUI

Property value

A String that specifies or receives the HTML filename.

Remarks

The gadget Settings button is activated when the settingsUI property is assigned a value.

Examples

The following example demonstrates how to use the settingsUI property to enable the gadget Settings dialog box.

// Enable the gadget settings functionality. 
System.Gadget.settingsUI = "Example.html";

Requirements

Minimum supported client
Windows Vista [desktop apps only]
Minimum supported server
Windows Server 2008 [desktop apps only]
End of client support
Windows 7
End of server support
Windows Server 2008
IDL
Sidebar.idl
DLL
Sidebar.Exe (version 1.00 or later)

See also

System.Gadget

Reference

System.Gadget.Settings

read

write

onSettingsClosed

onSettingsClosing

onShowSettings

Conceptual

Developing a Gadget for Windows Sidebar Part 1: The Basics