F > fscommand |
![]() ![]() ![]() |
fscommand
Availability
Flash Player 3.
Usage
fscommand(
"command
",
"parameters
")
Parameters
command
A string passed to the host application for any use or a command passed to the stand-alone Flash Player.
parameters
A string passed to the host application for any use or a value passed to the Flash Player.
Returns
Nothing.
Description
Action; allows the Flash movie to communicate with either the Flash Player, or the program hosting the Flash Player, such as a Web browser. You can also use the fscommand
action to pass messages to Macromedia Director, or to Visual Basic, Visual C++, and other programs that can host ActiveX controls.
Usage 1: To send a message to the Flash Player, you must use predefined commands and parameters. The following table shows the values you can specify for the command
and parameters
parameters of the fscommand
action to control a movie playing in the stand-alone Flash player (including projectors):
Command |
Parameters |
Purpose |
---|---|---|
|
|
Closes the projector. |
|
|
Specifying |
|
|
Specifying false sets the player so that the movie is always drawn at its original size and never scaled. Specifying true forces the movie to scale to 100% of the player. |
|
|
Specifying |
|
|
Executes an application from within the projector. |
|
|
Specifying |
Usage 2: To use the fscommand
action to send a message to a scripting language such as JavaScript in a Web browser, you can pass any two parameters in the command
and parameters
parameters. These parameters can be strings or expressions and are used in a JavaScript function that "catches," or handles, the fscommand
action.
In a Web browser, the fscommand
action calls the JavaScript function moviename_DoFScommand
in the HTML page containing the Flash movie. The moviename
is the name of the Flash Player as assigned by the NAME
attribute of the EMBED
tag or the ID property of the OBJECT
tag. If you assign the Flash Player the name myMovie
, the JavaScript function called is myMovie_DoFScommand
.
Usage 3: The fscommand
action can send messages to Macromedia Director that are interpreted by Lingo as strings, events, or executable Lingo code. If the message is a string or an event, you must write the Lingo code to receive the message from the fscommand
action and carry out an action in Director. For more information, see the Director Support Center.
Usage 4: In Visual Basic, Visual C++, and other programs that can host ActiveX controls, fscommand
sends a VB event with two strings that can be handled in the environment's programming language. For more information, use the keywords Flash method
to search the Flash Support Center.
Example
Usage 1: In the following example, the fscommand
action sets the Flash Player to scale the movie to the full monitor screen size when the button is released.
on(release){ fscommand("fullscreen", true); }
Usage 2: The following example uses the fscommand
action applied to a button in Flash to open a JavaScript message box in an HTML page. The message itself is sent to JavaScript as the fscommand
parameter.
You must add a function to the HTML page that contains the Flash movie. This function, myMovie
_DoFSCommand
sits in the HTML page and waits for an fscommand
action in Flash. When an fscommand
is triggered in Flash (for example, when a user presses the button), the command
and parameter
strings are passed to the myMovie
_DoFSCommand
function. You can use the passed strings in your JavaScript or VBScript code in any way you like. In this example, the function contains a conditional if
statement that checks to see if the command string is "messagebox"
. If it is, a JavaScript alert box (or "messagebox") opens and displays the contents of the parameters
string.
function myMovie_DoFSCommand(command, args) { if (command == "messagebox") { alert(args); }
}
In the Flash document, add the fscommand
action to a button:
fscommand("messagebox", "This is a message box called from within Flash.")
You can also use expressions for the fscommand
action and parameters, as in the following example:
fscommand("messagebox", "Hello, " + name + ", welcome to our Web site!")
To test the movie, choose File > Publish Preview > HTML.
Note: If you publish your movie using the Flash with FSCommand template in the HTML Publish Settings, the myMovie_DoFSCommand
function is inserted automatically. The movie's NAME
and ID
attributes will be the filename. For example, for the file myMovie.fla,
the attributes would be set to myMovie
.
![]() ![]() ![]() |