﻿<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- saved from url=(0014)about:internet -->
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta name="book" content="ActionScript&nbsp;3.0&nbsp;Language&nbsp;and&nbsp;Components&nbsp;Reference"><link rel="stylesheet" href="../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../override.css" type="text/css"><title>flash.system Details (ActionScript 3.0)</title></head><body><script language="javascript" type="text/javascript" src="../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../help.js"></script><script language="javascript" type="text/javascript" src="../../cookies.js"></script><script language="javascript" type="text/javascript">  
            <!--  
			    
				asdocTitle = 'flash.system package - ActionScript 3.0 Language and Components Reference';

				var baseRef = '../../';

				window.onload = configPage;
			      
			    -->  
            </script>
<script language="javascript" type="text/javascript"><!--
function submitValue(){
var searchStr=document.getElementById('search-livedocs').value;
window.location="../../search.html"+"###"+searchStr;
}
--></script><script type="text/javascript">
		scrollToNameAnchor();
	</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">ActionScript 3.0 Language and Components Reference</td><td class="titleTableSearch" align="center"><form class="searchForm" method="get" action="../../search.html" onsubmit="submitValue();"><input class="hidden" name="loc" value="" type="hidden"><input class="hidden" name="termPrefix" value="" type="hidden"><input class="hidden" name="term" value="" type="hidden"><input class="hidden" name="area" value="" type="hidden"><input id="search-livedocs" name="search_text" value="" title="" type="text"> <input type="button" name="action" value="Search" onclick="submitValue()"></form></td><td class="titleTableTopNav" align="right"><a href="../../../../Flash/10.0_Welcome/index.html">Home</a>&nbsp;|&nbsp;<a href="../../package-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Packages</a>&nbsp;|&nbsp;<a href="../../class-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Classes</a>&nbsp;|&nbsp;<a href="../../language-elements.html">Language Elements</a>&nbsp;| <a href="../../all-index-Symbols.html" onclick="loadClassListFrame('../../index-list.html')">Index</a>&nbsp;|&nbsp;<a href="../../appendixes.html">Appendixes</a>&nbsp;|&nbsp;<a href="../../conventions.html">Conventions</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../index.html?flash/system/package.html&amp;flash/system/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../images/logo.jpg" class="logoImage" alt=" Adobe Logo " title=" Adobe Logo "></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">Package</td><td class="titleTableSubNav" id="subNav" align="right" colspan="2"><a href="package.html#methodSummary">Functions</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
                
                    
                

				<!--

				
				    
				

					if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Package"); titleBar_setSubNav(false,false,false	,false,false,false,false,false,false	,false,true,false,false,false);}

				    
				        
				    
				-->
                
                    
                
			</script><div class="MainContent"><br><a name="methodSummary"></a>The flash.system package contains one package-level function, <code>fscommand()</code>, which facilitates communication between a SWF file and its container.<div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th>&nbsp;</th><th colspan="2">Function</th><th>Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#fscommand()" class="signatureLink">fscommand</a>(command:<a href="../../String.html">String</a>, args:<a href="../../String.html">String</a> = ""):<a href="../../specialTypes.html#void">void</a></div><div class="summaryTableDescription">Lets the SWF file communicate with either Flash Player or the program hosting Flash Player, 
 such as a web browser.</div></td><td class="summaryTableOwnerCol">flash.system</td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader"> Function detail </div><a name="fscommand()"></a><a name="fscommand(String,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">fscommand</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">function</td></tr></table><div class="detailBody"><code> public function fscommand(command:<a href="../../String.html">String</a>, args:<a href="../../String.html">String</a> = ""):<a href="../../specialTypes.html#void">void</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b>Language Version:&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b>Runtime Versions:&nbsp;</b></td><td>AIR 1.0, Flash Player 9</td></tr></table><p></p><p></p><p>
        Lets the SWF file communicate with either Flash Player or the program hosting Flash Player, 
 such as a web browser. You can also use the
        <code>fscommand()</code>
        function to pass messages to 
 Director or to Visual Basic, Visual C++, and other programs that can host ActiveX controls.
        <p>
          The
          <code>fscommand()</code>
          function lets a SWF file communicate with a script in a web page. 
  However, script access is controlled by the web page's
          <code>allowScriptAccess</code>
          setting. 
  (You set this attribute in the HTML code that embeds the SWF file&mdash;for
  example, in the
          <code>PARAM</code>
          tag for Internet Explorer or the
          <code>EMBED</code>
          tag for Netscape.)
        </p>
        
        <ul><li>
            When
            <code>allowScriptAccess</code>
            is set to
            <code>"sameDomain"</code>
            (the default), 
  scripting is allowed only from SWF files that are in the same domain as the web page.
          </li><li>
            When
            <code>allowScriptAccess</code>
            is set to
            <code>"always"</code>
            , 
  the SWF file can communicate with the HTML page in which it is embedded 
  even when the SWF file is from a different domain than the HTML page.
          </li><li>
            When
            <code>allowScriptAccess</code>
            is set to
            <code>"never"</code>
            , 
  the SWF file cannot communicate with any HTML page. Note that using this value is deprecated and not recommended, 
  and shouldn't be necessary if you don't serve untrusted SWF files from your own domain. 
  If you do need to serve untrusted SWF files, Adobe recommends that you create a distinct subdomain 
  and place all untrusted content there.
          </li></ul>
        
        <p>
          You can prevent a SWF file from using this method by setting the
          <code>allowNetworking</code>
          parameter of the the
          <code>object</code>
          and
          <code>embed</code>
          tags in the HTML page that contains the SWF content.
        </p>
        
        <p>
          The
          <code>fscommand()</code>
          function is not allowed if the calling SWF file is in 
  the local-with-file-system or local-with-network sandbox and the containing HTML page is in 
  an untrusted sandbox.
        </p>
        
        <p>For more security-related information, see the following:</p>
        
        <ul><li>
            The
            <a href="http://www.adobe.com/go/flashcs4_prog_as3_security_en" target="external">security chapter</a>
            in the
            <i>Programming ActionScript 3.0</i>
            book and the latest comments on LiveDocs
          </li><li>
            The Flash Player Developer Center Topic:
            <a href="http://www.adobe.com/go/devnet_security_en" target="external">Security</a>
          </li></ul>
        
        <p>
          Usage 1: To use
          <code>fscommand()</code>
          to send a message to Flash Player, you must use predefined commands and parameters. The 
 following table shows the values that you can specify for the
          <code>fscommand()</code>
          function's
          <code>command</code>
          and
          <code>args</code>
          parameters. These values control SWF files that are playing in Flash Player, including projectors. (A
          <i>projector</i>
          is a SWF file saved in a format that can run as a stand-alone application&mdash;that is, without Flash Player.)
        </p>
        
        <table class="innertable" ><tr><th>Command</th><th>Parameter (args)</th><th>Purpose</th></tr><tr><td>
                  <code>quit</code>
                </td><td>None</td><td>Closes the projector.</td></tr><tr><td>
                  <code>fullscreen</code>
                </td><td>
                  <code>true</code>
                  or
                  <code>false</code>
                </td><td>
                  Specifying
                  <code>true</code>
                  sets Flash Player to full-screen mode. Specifying
                  <code>false</code>
                  returns the player to normal menu view.
                </td></tr><tr><td>
                  <code>allowscale</code>
                </td><td>
                  <code>true</code>
                  or
                  <code>false</code>
                </td><td>
                  Specifying
                  <code>false</code>
                  sets the player so that the SWF file is always drawn 
                      at its original size and never scaled. Specifying
                  <code>true</code>
                  forces the SWF file to scale to 100% of the 
                      player.
                </td></tr><tr><td>
                  <code>showmenu</code>
                </td><td>
                  <code>true</code>
                  or
                  <code>false</code>
                </td><td>
                  Specifying
                  <code>true</code>
                  enables the full set of context menu items. Specifying
                  <code>false</code>
                  hides all of the context menu items except About Flash Player and Settings.
                </td></tr><tr><td>
                  <code>exec</code>
                </td><td>Path to application</td><td>Executes an application from within the projector.</td></tr><tr><td>
                  <code>trapallkeys</code>
                </td><td>
                  <code>true</code>
                  or
                  <code>false</code>
                </td><td>
                  Specifying
                  <code>true</code>
                  sends all key events, including accelerator keys, to 
                      the
                  <code>onClipEvent(keyDown/keyUp)</code>
                  handler in Flash Player.
                </td></tr></table>
        
        <p>
          Not all of the commands listed in the table are available in all applications:
          <ul><li>None of the commands are available in web players.</li><li>All of the commands are available in stand-alone applications, such as projectors.</li><li>
              Only
              <code>allowscale</code>
              and
              <code>exec</code>
              are available in test-movie players.
            </li></ul>
          
        </p>
        
        <p>
          The
          <code>exec</code>
          command can contain only the characters A-Z, a-z, 0-9, period (.), and underscore (_). The
          <code>exec</code>
          command runs in the subdirectory fscommand only. In other words, if you use the
          <code>exec</code>
          command to call an application, the
 application must reside in a subdirectory named fscommand. The
          <code>exec</code>
          command works only from within a Flash projector  
 file.
        </p>
        
        <p>
          Usage 2: To use
          <code>fscommand()</code>
          to send a message to a scripting language such as JavaScript in a web browser, you can 
 pass any two parameters in the
          <code>command</code>
          and
          <code>args</code>
          parameters. These parameters can be strings or  
 expressions, and they are used in a JavaScript function that handles, or
          <i>catches</i>
          , the
          <code>fscommand()</code>
          function.
        </p>
        
        <p>
          In a web browser,
          <code>fscommand()</code>
          calls the JavaScript function
          <code>moviename_DoFScommand</code>
          , which resides in the  
 web page that contains the SWF file. For
          <code>moviename</code>
          , supply the name of the Flash object that you used for the
          <code>NAME</code>
          attribute of the
          <code>EMBED</code>
          tag or the ID property of the
          <code>OBJECT</code>
          tag. If you assign the SWF file
 the name "myMovie", the JavaScript function
          <code>myMovie_DoFScommand</code>
          is called.
        </p>
        
        <p>
          In the web page that contains the SWF file, set the
          <code>allowScriptAccess</code>
          attribute to allow or deny the SWF file's 
 ability to access the web page, as described above. (You set this attribute in the HTML code that embeds the SWF file&mdash;for example, in the
          <code>PARAM</code>
          tag for Internet Explorer or the
          <code>EMBED</code>
          tag for Netscape.)
        </p>
        
        <p>In Flash Player 10 and later running in a browser, using this method programmatically to
 open a pop-up window may not be successful.  Various browsers (and browser configurations) may block pop-up windows 
 at any time; it is not possible to guarantee any pop-up window will appear.  
 However, for the best chance of success, use this method to open a pop-up window only in code that executes 
 as a direct result of a user action (for example, in an event handler for a mouse click or key-press event.)</p>
        
        <p>
          Usage 3: The
          <code>fscommand()</code>
          function can send messages to Director (Macromedia Director from Adobe). 
 These messages are interpreted by Lingo (the Director scripting language) as strings, events, or executable Lingo 
 code. If a message is a string or an event, you must write the Lingo code to receive the message from the
          <code>fscommand()</code>
          function and carry out an action in Director. For more information, see the Director Support 
 Center at
          <a href="http://www.adobe.com/support/director/" target="external">www.adobe.com/support/director/</a>
          .
        </p>
        
        <p>
          Usage 4: In VisualBasic, Visual C++, and other programs that can host ActiveX controls,
          <code>fscommand()</code>
          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 at
          <a href="http://www.adobe.com/support/flash/" target="external">www.adobe.com/support/flash/</a>
          .
        </p>
        
        <p>
          <b>Note:</b>
          The ExternalInterface class provides better functionality
 for communication between JavaScript and ActionScript (Usage 2) and between ActionScript and VisualBasic, Visual C++, or other 
 programs that can host ActiveX controls (Usage 4). You should continue to use
          <code>fscommand()</code>
          for sending messages to Flash 
 Player (Usage 1) and Director (Usage 3).
        </p>
        
      </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">command</span>:<a href="../../String.html">String</a></code> &mdash; A string passed to the host application for any use, or a command passed to Flash Player.</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">args</span>:<a href="../../String.html">String</a></code> (default = "<code></code>")<code></code> &mdash; A string passed to the host application for any use, or a value passed to Flash Player.</td></tr></table></p><br/><span class="label">Throws</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code><a href="../../Error.html">Error</a> </code> &mdash; If the function is not called in response to a user action, such as a mouse
 event or keypress event.</td></tr></table><br/><span class="label"> Example </span><br/><br/><div class="detailBody">
        The following example shows how
        <code>fscommand()</code>
        can be used to direct
 Flash Player to go into full screen mode and not allow scaling.  An orange box is then
 added to the stage using
        <code>draw()</code>
        .  In
        <code>draw()</code>
        , a
        <code>click</code>
        event listener is added named
        <code>clickHandler()</code>
        , which responds to
        <code>click</code>
        events by directing Flash Player to exit using another call to
        <code>fscommand().</code>
        
        <p>
          <b>Note:</b>
          this example should be executed in the standalone Flash Player and
 not within a web browser.
        </p>
        
        <div class="listing"><pre>package {
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.system.fscommand;
    import flash.events.MouseEvent;

    public class FSCommandExample extends Sprite {
        private var bgColor:uint = 0xFFCC00;
        private var size:uint = 100;

        public function FSCommandExample() {
            fscommand("fullscreen", "true");
            fscommand("allowscale", "false");
            draw();
        }

        private function clickHandler(event:MouseEvent):void {
            fscommand("quit");
            trace("clickHandler");
        }

        private function draw():void {
            var child:Sprite = new Sprite();
            child.graphics.beginFill(bgColor);
            child.graphics.drawRect(0, 0, size, size);
            child.graphics.endFill();
            child.buttonMode = true;
            addEventListener(MouseEvent.CLICK, clickHandler);

            var label:TextField = new TextField();
            label.text = "quit";
            label.selectable = false;
            label.mouseEnabled = false;
            child.addChild(label);

            addChild(child);
        }
    }
}</pre></div>
      </div></div><p></p><center class="copyright"> &copy; 2004-2008 Adobe Systems Incorporated. All rights reserved. <br/>Thu Oct 30 2008, 07:14 PM -07:00  </center><div style="display:none">flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system flash.system </div></div></body></html>
