Getting Started

Platform

• alert()
• browse()
• confirm()
• loadMedia()

• environment

Utilities

• getFlashHeader()
• getInternetConnection()
• getURL()
• loadMovieInSandBox()

Widget

• onClose()
• onDropFile()
• onDropString()
• onMemoryUpdate()
• onMenuCommand()
• onPaste()
• onResize()
• onSettings()

• addMenuItem()
• bounce()
• center()
• close()
• deleteMenu()
• dock()
• getMemory()
• getParameter()
• setFrameRate()
• setMaximumSize()
• setMemory()
• setMinimumSize()
• setParameter()
• setSize()
• setUtilityOffset()
• setMetadata()
• shake()
• startDrag()
• stopDrag()
• trace()

• allowDocking
• allowScaling
• allowSettings
• allowUtility
• height
• isDocked
• width

Widget.getParameter()

Availability

Flash Player 7 + TheSpringBox V1

Usage

Widget.getParameter() : Object;

Parameters

None.

Returns

An Object or String with the properties preset when the widget is launched using or the object or string stored using the Widget.setParameter method.

Description

Method; used to retrieve the parameter to which a widget instance is to respond to. This method is typically called when the widget first starts up in order to know what data to display.

Example

The function in this example will retrieve the parameter that was set when the widget was launched; in the case of this widget, the parameter is an XML feed URL:

function initWidget() {
  var parameter:Object = Widget.getParameter();
  var currentFeed:Object = parameter.feed;
  loadFeed(currentFeed);
};
    

See also

Widget.setParameter()