User Guide

232 Chapter 2: ActionScript Language Reference
CustomActions.get()
Availability
Flash Player 6.
Usage
CustomActions.get(customName:String) : String
Parameters
customName
The name of the custom action definition to retrieve.
Returns
If the custom action XML definition is located, returns a string; otherwise, returns undefined.
Description
Method; reads the contents of the custom action XML definition file named customName.
The name of the definition file must be a simple filename, without the .xml file extension, and
without any directory separators (':', '/' or '\').
If the definition file specified by the
customName cannot be found, a value of undefined is
returned. If the custom action XML definition specified by the
customName parameter is located,
it is read in its entirety and returned as a string.
Example
The following example lists the custom actions in a ComboBox instance, and gets the custom
action when a Button instance is clicked. Drag an instance of a ComboBox, Button, and TextArea
onto the Stage. Give the ComboBox an instance name of
customActionName_cb, the TextArea
an instance name of
customActionXml_ta, and the Button an instance name of view_button.
Enter the following ActionScript on Frame 1 of the Timeline:
import mx.controls.*;
var customActionName_cb:ComboBox;
var customActionXml_ta:TextArea;
var view_button:Button;
customActionName_cb.dataProvider = CustomActions.list();
customActionXml_ta.editable = false;
var viewListener:Object = new Object();
viewListener.click = function(evt:Object) {
var caName:String = String(customActionName_cb.selectedItem);
customActionXml_ta.text = CustomActions.get(caName);
};
view_button.addEventListener("click", viewListener);