System.Gadget.onShowSettings event

[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. ]

Event fired when the gadget Settings dialog is requested.

Syntax

iRetVal = System.Gadget.onShowSettings(
  handler
)

Parameters

handler

The name of the function to call when the event is fired.

Examples

The following example demonstrates how to use the onShowSettings event.

// Delegate for the show settings event. 
System.Gadget.onShowSettings = SettingsShow;

// --------------------------------------------------------------------
// Handle the Settings dialog show event.
// --------------------------------------------------------------------
function SettingsShow()
{
    SetContentText("Settings opening.");
}

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