System.Gadget.visibilityChanged event

Article
05/31/2018

[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 visibility changes due to the Windows Sidebar being hidden or displayed.

Syntax

iRetVal = System.Gadget.visibilityChanged(
  handler
)

Parameters

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

Remarks

This event can be used to suspend or resume gadget execution as appropriate.

This event is fired only when the gadget is docked to the Sidebar.

This event updates the gadget visible property.

Examples

The following example demonstrates how to use the visibilityChanged event to suspend or resume a timer based on the gadget visibility.

// Delegate for the gadget visibility changed event.
System.Gadget.visibilityChanged = checkVisibility;

// --------------------------------------------------------------------
// Handle the gadget visiblity changed event.
// event = Event argument.
// --------------------------------------------------------------------
function VisibilityChanged(event)
{
    if (!System.Gadget.visible)
    {
        // Stop the timer;
    }
    else
    {
        // Start the timer;
    }
}

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)