background.src property

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

Gets or sets the image file used by the g:background element.

This property is read/write.

Syntax

strsrc = background.src
background.src = strsrc

Property value

A String that specifies or receives a UNC path or a URI.

Remarks

Valid image filetypes are .JPG, .BMP, .GIF, or .PNG.

Special characters in UNC paths should be escaped with a '\'.

Examples

The following example demonstrates how to specify a new image for the g:background element from a gadget script file.

// imgBackground is the value of the 'id' attribute for the g:background element.
imgBackground.src = "https://www.microsoft.com/logo.gif";
// or
imgBackground.src = "..\\aero\&amp;logo.png";

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)

Share via