background.softedge 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 amount of edge softening that is applied to the g:background element.

This property is read/write.

Syntax

isoftedge = background.softedge
background.softedge = isoftedge

Property value

An Integer that specifies or receives the radius, in pixels, of the softEdge effect. The value ranges from 0 to 30.

(0)

Default. No edge softening applied. The target element is not modified.

(30)

Maximum edge softening applied.

Remarks

softEdge blurs the outside edge of the element by the specified radius. This is in contrast to the blur effect, which blurs the entire element.

The softEdge effect can be specified in the gadget HTML and Script files.

The opacity of the g:background element must be set to a value of at least 1 for the softEdge effect to be visible.

Examples

The following example demonstrates how to add a softEdge effect to the g:background element from a gadget Script file.

\\ imgBackground is the value of the 'id' attribute for the g:background element.
imgBackground.softedge = 5;

The following example demonstrates how to add a softEdge effect to the g:background element in the gadget HTML file.

<g:background 
        id="imgBackground" 
        src="images/background.png" 
        softedge="5">

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)

Partager via