System.Gadget.SideShow.remove Method

Article
03/12/2010

Removes an element specified by a content ID.

Syntax

retVal = System.Gadget.SideShow.remove(
  intID
)

Parameters

intID [in]
int Sets Integer that specifies the SideShow content ID.

Remarks

When calling addText and addImage repeatedly with the same ID, it is recommended that you call remove or removeAll prior to updating the content for a given ID.

Verify that System.Gadget.SideShow.enabled returns true before using other System.Gadget.SideShow object members.

Examples

The following example demonstrates how to remove specific elements from a SideShow gadget.

//
// sideshow.js - Contains all Windows SideShow specific code.
//

sideshow =
{
    imageIdUp: 50,
    imageIdEqual: 51,
    imageIdDown: 52,
    
    // --------------------------------------------------------------------
    // initialize() - Initialize the SideShow portion of the gadget.
    // --------------------------------------------------------------------
    initialize: function()
    {
        // Ensure SideShow is enabled for this machine.
        if (!System.Gadget.SideShow.enabled())
        {
            // If it is not available, return without initializing anything.
            return;
        }
        
        System.Gadget.SideShow.setFriendlyName("Stocks");
        sideshow.clearContent();

        // Add images.
        System.Gadget.SideShow.addImage(sideshow.imageIdUp, System.Gadget.path + "\\images\\up.gif");
        System.Gadget.SideShow.addImage(sideshow.imageIdEqual, System.Gadget.path + "\\images\\equal.gif");
        System.Gadget.SideShow.addImage(sideshow.imageIdDown, System.Gadget.path + "\\images\\down.gif");
    },
    
    // --------------------------------------------------------------------
    // clearContent() - Removes all content from the device and puts in default text.
    // --------------------------------------------------------------------
    clearContent: function()
    {
        // Remove content from the device.
        System.Gadget.SideShow.remove(sideshow.imageIdUp);
        System.Gadget.SideShow.remove(sideshow.imageIdEqual);
        System.Gadget.SideShow.remove(sideshow.imageIdDown);
        System.Gadget.SideShow.addText(0, "ServiceIsUnavailable");    
    }
}

Requirements

Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
IDL	Sidebar.idl
DLL	Sidebar.Exe version 1.00 or later