Share via


System.Gadget.background property

[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 file path for the gadget background image.

This property is read/write.

Syntax

strbackground = System.Gadget.background
System.Gadget.background = strbackground

Property value

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

Remarks

The background property is initialized by the g:background element in the gadget HTML file.

The background property should be modified after the gadget has finished loading.

Note

It is recommended that the src property be used instead of the background property if the script is located within the body tags of the gadget HTML file. The System.Gadget object is not guaranteed to exist in these cases.

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

System.Gadget