System.Gadget.visible Property

Article
03/12/2010

Gets the visibility state of the gadget.

This property is read-only.

Syntax

propVal = System.Gadget.visible()

Parameters

bVisible [out]
Retrieves the visibility state of the gadget.

Value Meaning

TRUE
Gadget is visible.

FALSE
Gadget is not visible.

Value	Meaning
TRUE	Gadget is visible.
FALSE	Gadget is not visible.

Remarks

This property is updated by the visibilityChanged event.

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
Minimum supported server	Windows Server 2008
IDL	Sidebar.idl
DLL	Sidebar.Exe version 1.00 or later