Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
removeObjects
Collapse the table of content
Expand the table of content

background.removeObjects method

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

Removes all g:text and g:image elements added to the gadget background using the addTextObject and addImageObject methods.

Syntax


iRetVal = background.removeObjects()

Parameters

This method has no parameters.

Remarks

The initial background image is unaffected.

Examples

The following example demonstrates how to add both g:text and g:image elements to a g:background and then remove them using the removeObjects method


\\ Add g:text and g:image elements to the g:background element.
\\ imgBackground is the value of the 'id' attribute for the g:background element.
var imgGlow = imgBackground.addImageObject("file://img.png", 0, 0);
var txtShadow = imgBackground.addTextObject("test", "Verdana", 25, "Red", 50, 50);

\\ Remove all text and image elements, leaving the initial background image unchanged.
imgBackground.removeObjects();

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

Reference
background
image
text

 

 

Community Additions

ADD
Show:
© 2015 Microsoft