A-C > CustomActions.install

 

CustomActions.install

Availability

Flash Player 6.

Usage

CustomActions.install(customActionsName, customXMLDefinition)

Parameters

customActionsName The name of the custom action definition to install.

customXMLDefinition The text of the XML definition to install.

Returns

Nothing.

Description

Method; installs a new custom action XML definition file indicated by the customActionsName parameter. The contents of the file is specified by the string customXMLDefinition.

The name of the definition file must be a simple filename, without the .xml file extension, and without any directory separators (':', '/' or '\').

If a custom actions file already exists with the name customActionsName, it is overwritten.

If an error occurs during installation, a false value is returned; otherwise, a value of true is returned to indicate that the custom action has been successfully installed.

If the Configuration/ActionsPanel/CustomActions directory does not exist when this method is invoked, the directory is created.