image.brightness 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 brightness of the g:image element.

This property is read/write.

Syntax

brightness = image.brightness
image.brightness = brightness

Property value

A Floating-point that specifies or receives the "white" level applied to the target element. The value ranges from 0.0 to 100.0.

(0.0)

Default. No brightness effect applied. The target element is not modified.

(1.0)

Brightness effect of 100%. The target element has no detail, color, or contrast; it is opaque but effectively blank (white).

(100.0)

Brightness effect of 1%.

Remarks

The brightness effect can be specified in the gadget HTML and script files.

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

Examples

The following example demonstrates how to add a brightness effect to the g:image element from a gadget script file.

\\ imgBackground is the value of the 'id' attribute for the g:background element.
var imgBrightness = imgBackground.addImageObject(file, intX, intY);
imgBrightness.brightness = 1.0;

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

<g:image src="..\aerologo.png" brightness="1.0"/>

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)