Untitled - JSFL-Wiki

fl summary

#### Availability

Flash MX 2004.

#### Description

The flash object represents the Flash application. You can use flash or fl to refer to this object. This documentation uses fl in code samples throughout.

#### Method summary

The following methods can be used with the flash object:

| Method |--------------------------------------------------|- | fl.addEventListener() (../flash_object_(fl)/fl1.md) | fl.addToolInToolbar() (../flash_object_(fl)/fl1.md) | fl.browseForFileURL() (../flash_object_(fl)/fl3.md) | fl.browseForFolderURL() (../flash_object_(fl)/fl4.md) | fl.clearPublishCache() (../flash_object_(fl)/fl5.md) | fl.clipCopyString() (../flash_object_(fl)/fl6.md) | fl.closeAll() (../flash_object_(fl)/fl7.md) | fl.closeAllPlayerDocuments() (../flash_object_(fl)/fl8.md) | fl.closeDocument() (../flash_object_(fl)/fl9.md) | fl.copyLibraryItem() (../flash_object_(fl)/fl15.md) | fl.createDocument() (../flash_object_(fl)/fl16.md) | fl.exportPublishProfileString() (../flash_object_(fl)/fl22.md) | fl.fileExists() (../flash_object_(fl)/fl24.md) | fl.findDocumentDOM() (../flash_object_(fl)/fl25.md) | fl.findDocumentIndex() (../flash_object_(fl)/fl26.md) | fl.findObjectInDocByName() (../flash_object_(fl)/fl27.md) | fl.findObjectInDocByType() (../flash_object_(fl)/fl28.md) | fl.getAppMemoryInfo() (../flash_object_(fl)/fl30.md) | fl.getDocumentDOM() (../flash_object_(fl)/fl31.md) | Description |
---------------------------------------------------------------------------------------------------------------|
| Registers a function to be called when a specific event is received. |
| Add the specified tool from master toolbar to main toolbar, appends in the last. |
| Opens a File Open or File Save system dialog box and lets the user specify a file to be opened or saved. |
| Displays a Browse for Folder dialog box and lets the user select a folder. |
| Clears the publish cache. |
| Copies the specified string to the Clipboard. |
| Closes all open documents, displaying the Save As dialog box for any documents that were not previously saved. |
| Closes all the SWF files that were opened with Control > Test Movie. |
| Closes the specified document. |
| Silently copies a library item from a document without exposing the item in the Flash Pro user interface. |
| Opens a new document and selects it. |
| Uniform Resource Identifier (URI) from which to export publish settings. |
| Checks whether a file already exists on disk. |
| Lets you target a specific file by using its unique identifier. |
| Returns an array of integers that represent the position of a document in the fl.documents array. |
| Exposes elements with instance names that match specified text. |
| Exposes elements of a specified element type in a document. |
| Returns an integer that represents the number of bytes being used in a specified area of Flash.exe memory. |
| Retrieves the DOM (Document object (../Document_object/document_summary.md)) of the currently active document. |

<table><thead><tr class="header"><th><strong>Method</strong></th><th><strong>Description</strong></th></tr></thead><tbody><tr class="odd"><td><a href="../flash_object_(fl)/fl35.md">fl.getSwfPanel()</a></td><td>Returns the SWFPanel object based on the panel's localized name or its SWF filename.</td></tr><tr class="even"><td><a href="../flash_object_(fl)/fl32.md">fl.getThemeColor()</a></td><td>Retrieves a theme color that matches the parameter specified theme parameter name.</td></tr><tr class="odd"><td><a href="../flash_object_(fl)/fl33.md">fl.getThemeColorParameters()</a></td><td>Retrieves an array of theme parameter names.</td></tr><tr class="even"><td><a href="../flash_object_(fl)/fl34.md">fl.getThemeFontInfo()</a></td><td>Return either the font style or the font size that is used to draw the UI of the specified size.</td></tr><tr class="odd"><td><a href="../flash_object_(fl)/fl37.md">fl.isFontInstalled()</a></td><td>Determines whether a specified font is installed.</td></tr><tr class="even"><td><a href="../flash_object_(fl)/fl40.md">fl.mapPlayerURL()</a></td><td>Maps an escaped Unicode URL to a UTF-8 or MBCS URL.</td></tr><tr class="odd"><td><a href="../flash_object_(fl)/fl45.md">fl.openDocument()</a></td><td>Opens a Flash (FLA) document for editing in a new Flash Document window and gives it focus.</td></tr><tr class="even"><td><a href="../flash_object_(fl)/fl46.md">fl.openScript()</a></td><td>Opens a script (JSFL, AS, ASC) or other file (XML, TXT) in the Flash text editor.</td></tr><tr class="odd"><td><a href="../flash_object_(fl)/fl55.md">fl.quit()</a></td><td>Quits Flash, prompting the user to save any changed documents.</td></tr><tr class="even"><td><a href="../flash_object_(fl)/fl56.md">fl.reloadEffects() - dropped</a></td><td>Dropped in Adobe Animate.</td></tr><tr class="odd"><td><a href="../flash_object_(fl)/fl57.md">fl.reloadTools()</a></td><td>Rebuilds the Tools panel from the toolconfig.xml file.</td></tr><tr class="even"><td><a href="../flash_object_(fl)/fl58.md">fl.removeEventListener()</a></td><td><p>Unregisters a function that was registered using</p><p>fl.addEventListener().</p></td></tr><tr class="odd"><td><a href="../flash_object_(fl)/fl59.md">fl.resetAS3PackagePaths()</a></td><td>Resets the global Classpath setting in the ActionScript 3.0 Settings dialog box to the default value.</td></tr><tr class="even"><td><a href="../flash_object_(fl)/fl60.md">fl.resetPackagePaths() - dropped</a></td><td>Dropped in Adobe Animate.</td></tr><tr class="odd"><td><a href="../flash_object_(fl)/fl62.md">fl.runScript()</a></td><td>Executes a JavaScript file.</td></tr><tr class="even"><td><a href="../flash_object_(fl)/fl63.md">fl.saveAll()</a></td><td>Saves all open documents, displaying the Save As dialog box for any documents that were not previously saved.</td></tr><tr class="odd"><td><a href="../flash_object_(fl)/fl64.md">fl.saveDocument()</a></td><td>Saves the specified document as a FLA document.</td></tr><tr class="even"><td><a href="../flash_object_(fl)/fl65.md">fl.saveDocumentAs()</a></td><td>Displays the Save As dialog box for the specified document.</td></tr><tr class="odd"><td><a href="../flash_object_(fl)/fl67.md">fl.selectElement()</a></td><td>Enables selection or editing of an element.</td></tr><tr class="even"><td><a href="../flash_object_(fl)/fl68.md">fl.selectTool()</a></td><td>Selects the specified tool in the Tools panel.</td></tr><tr class="odd"><td><a href="../flash_object_(fl)/fl69.md">fl.setActiveWindow()</a></td><td>Sets the active window to be the specified document.</td></tr><tr class="even"><td><a href="../flash_object_(fl)/fl71.md">fl.setPrefBoolean()</a></td><td>Sets a boolean preference value.</td></tr><tr class="odd"><td><a href="../flash_object_(fl)/fl70.md">fl.showIdleMessage()</a></td><td>Lets you disable the warning about a script running too long.</td></tr><tr class="even"><td><a href="../flash_object_(fl)/fl75.md">fl.toggleBreakpoint()</a></td><td>Toggles a breakpoint for the given .as file at the given line.</td></tr><tr class="odd"><td><a href="../flash_object_(fl)/fl77.md">fl.trace()</a></td><td>Sends a text string to the Output panel.</td></tr><tr class="even"><td><a href="../flash_object_(fl)/fl79.md">fl.xmlPanel()</a></td><td>Launches the XML To UI dialog from a URI that points to an XML-format file.</td></tr><tr class="odd"><td><a href="../flash_object_(fl)/fl80.md">fl.xmlPanelFromString()</a></td><td>Launches the XML To UI dialog from an XML-format string.</td></tr></tbody></table>

#### Property summary

The following properties can be used with the flash object.

| Property | Description |
|------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| fl.actionsPanel (../flash_object_(fl)/fl.md) | Read-only; an actionsPanel object (../actionsPanel_object/actionsPanel_summary.md). |
| fl.as3PackagePaths (../flash_object_(fl)/fl2.md) | A string that corresponds to the global Classpath setting in the ActionScript 3.0 Settings dialog box. |
| fl.compilerErrors (../flash_object_(fl)/fl10.md) | Read-only; a compilerErrors object (../compilerErrors_object/compilerErrors_summary.md). |
| fl.componentsPanel (../flash_object_(fl)/fl11.md) | Read-only; a componentsPanel object (../componentsPanel_object/componentsPanel_summary.md), which represents the Components panel. |
| fl.configDirectory (../flash_object_(fl)/fl12.md) | Read-only; a string that specifies the full path for the local user’s Configuration folder as a platform-specific path. |
| fl.configURI (../flash_object_(fl)/fl13.md) | Read-only; a string that specifies the full path for the local user’s Configuration directory as a file:/// URI. |
| fl.contactSensitiveSelection (../flash_object_(fl)/fl14.md) | A Boolean value that specifies whether Contact Sensitive selection mode is enabled. |
| fl.createNewDocList (../flash_object_(fl)/fl17.md) | Read-only; an array of strings that represent the various types of documents that can be created. |
| fl.createNewDocListType (../flash_object_(fl)/fl18.md) | Read-only; an array of strings that represent the file extensions of the types of documents that can be created. |
| fl.createNewTemplateList (../flash_object_(fl)/fl19.md) | Read-only; an array of strings that represent the various types of templates that can be created. |
| fl.documents (../flash_object_(fl)/fl20.md) | Read-only; an array of Document objects (see Document object (../Document_object/document_summary.md)) that represent the documents (FLA files) that are currently open for editing. |
| fl.drawingLayer (../flash_object_(fl)/fl21.md) | The drawingLayer object that an extensible tool should use when the user wants to temporarily draw while dragging. |
| fl.externalLibraryPath (../flash_object_(fl)/fl23.md) | A string that contains a list of items in the global ActionScript 3.0 External library path, which specifies the location of SWC files used as runtime shared libraries. |
| fl.flexSDKPath (../flash_object_(fl)/fl29.md) | A string that specifies the path to the Flex SDK folder, which contains bin, frameworks, lib, and other folders. |
| fl.installedPlayers (../flash_object_(fl)/fl36.md) | Returns an array of generic objects corresponding to the list of installed Flash Players in the document Property inspector. |
| fl.languageCode (../flash_object_(fl)/fl38.md) | Returns the five character code identifying the locale of the application’s user interface. |
| fl.libraryPath (../flash_object_(fl)/fl39.md) | A string that contains a list of items in the global ActionScript 3.0 Library path, which specifies the location of SWC files or folders containing SWC files. |
| fl.Math (../flash_object_(fl)/fl41.md) | Read-only; the Math object (../Math_object/Math_summary.md), which provides methods for matrix and point operations. |
| fl.mruRecentFileList (../flash_object_(fl)/fl42.md) | Read-only; an array of the complete filenames in the Most Recently Used (MRU) list that the Flash authoring tool manages. |
| fl.mruRecentFileListType (../flash_object_(fl)/fl43.md) | Read-only; an array of the file types in the MRU list that the Flash authoring tool manages. |
| fl.packagePaths - dropped (../flash_object_(fl)/fl48.md) | Dropped in Adobe Animate. |
| fl.publishCacheDiskSizeMax (../flash_object_(fl)/fl50.md) | An integer that sets the disk cache size limit preference. |
| fl.publishCacheEnabled (../flash_object_(fl)/fl51.md) | A boolean value that sets whether publish cache is enabled. |
| fl.publishCacheMemoryEntrySizeLimit (../flash_object_(fl)/fl52.md) | An integer property that sets the maximum size for the memory cache entry preference. |

| Property | Description |
|-----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
| fl.publishCacheMemorySizeMax (../flash_object_(fl)/fl53.md) | An integer that sets the memory cache size limit preference. |
| fl.objectDrawingMode (../flash_object_(fl)/fl44.md) | An integer that represents the object drawing mode that is enabled. |
| fl.outputPanel (../flash_object_(fl)/fl47.md) | Read-only; reference to the outputPanel object (../outputPanel_object/outputPanel_summary.md). |
| fl.presetPanel (../flash_object_(fl)/fl49.md) | Read-only; a presetPanel object (../presetPanel_object/presetPanel_summary.md). |
| fl.scriptURI (../flash_object_(fl)/fl66.md) | Read-only; a string that represents the path of the currently running JSFL script, expressed as a file:/// URI. |
| fl.sourcePath (../flash_object_(fl)/fl72.md) | A string that contains a list of items in the global ActionScript 3.0 Source path, which specifies the location of ActionScript class files. |
| fl.spriteSheetExporter (../flash_object_(fl)/fl73.md) | Returns an instance of SpriteSheetExporter object. |
| fl.swfPanels (../flash_object_(fl)/fl74.md) | An array of registered swfPanel objects (see swfPanel object (../swfPanel_object/swfPanel_summary.md)). |
| fl.tools (../flash_object_(fl)/fl76.md) | Read-only; an array of Tools objects. |
| fl.version (../flash_object_(fl)/fl78.md) | Read-only; the long string version of the Flash authoring tool, including platform. |
| fl.xmlui (../flash_object_(fl)/fl81.md) | Read-only; an XMLUI object (../XMLUI_object/xmlui_summary.md). |