Previous | Next

STF.setActiveWallpaper()

Availability

Flash MX 2004 or 8 swf w/ ScreenTimeScreenSaver component + ScreenTime

3.0 /

3.0

Usage

STF.setActiveWallpaper(fileName:String, tileOrCenterOrStretch:String) : Boolean

Parameters

fileName - Filename of desired wallpaper. The fileName can be a relative path from the working directory or an explicit path to any valid wallpaper file on the computer. On the Mac the image will be stretched to fill the entire desktop. On the PC the image can tiled, stretched, or centered on the desktop.

tileOrCenterOrStretch - display type - Windows Only - if no display type is specified the image is stretched to fill the desktop.

"TILE" - tile image.
"CENTER" - center image.
"STRETCH" - stretch image - DEFAULT.

Returns

A boolean.; This value is returned as a parameter to the registered callback. See the example below or STF.registerCallBack() for more information on return variable handling.

Description

Method; Sets the specified file to be the current active wallpaper.

Example

This sample sets a file in the working directory to be the active wallpaper and stretches the image to fill the screen.

var fileName = "tibet.jpg";

setActiveWallpaper_btn.onRelease = function(){
	STF.setActiveWallpaper(fileName);
}