g:text.brightness Property

Gets or sets the brightness of the g:text element.

This property is read/write.

Syntax

propVal = g:text.brightness(fBrightness)

  
g:text.brightness(fBrightness)

   = propVal 

Parameters

fBrightness [in]
fBrightness [out]

Sets or retrieves the "white" level applied to the target element. The value ranges from 0.0 to 100.0.

ValueMeaning
0.0

Default. No brightness effect applied. Text is not modified.

1.0

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

100.0

Brightness effect of 1%.

 

Remarks

The opacity of the g:text 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:text element from a gadget script file.

\\ imgBackground is the value of the 'id' attribute for the g:background element.
var txtBrightness = imgBackground.addTextObject("test", "Verdana", 25, "Red", intX, intY);
txtBrightness.brightness = 1.0;

Requirements

Minimum supported clientWindows Vista
Minimum supported serverWindows Server 2008
IDLSidebar.idl
DLLSidebar.Exe version 1.00 or later

See Also

g:text
Reference
background
image

 

 

Send comments about this topic to Microsoft

Build date: 2/24/2010

Build type: SDK

Community Additions

Show: