flash.events

# UncaughtErrorEvents - AS3

Package | flash.events
Class | public class UncaughtErrorEvents
Inheritance | UncaughtErrorEvents EventDispatcher Object

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10.1, AIR 2

The UncaughtErrorEvents class provides a way to receive uncaught error events. An instance of this class dispatches an `uncaughtError` event when a runtime error occurs and the error isn't detected and handled in your code.

Use the following properties to access an UncaughtErrorEvents instance:

- `LoaderInfo.uncaughtErrorEvents`: to detect uncaught errors in code defined in the same SWF.
- `Loader.uncaughtErrorEvents`: to detect uncaught errors in code defined in the SWF loaded by a Loader object.

To catch an error directly and prevent an uncaught error event, do the following:

- Use a `try..catch` block to isolate code that potentially throws a synchronous error
- When performing an operation that dispatches an event when an error occurs, register a listener for that error event

If the content loaded by a Loader object is an AVM1 (ActionScript 2) SWF file, uncaught errors in the AVM1 SWF file do not result in an `uncaughtError` event. In addition, JavaScript errors in HTML content loaded in an HTMLLoader object (including a Flex HTML control) do not result in an `uncaughtError` event.

Related API Elements

LoaderInfo.uncaughtErrorEvents
Loader.uncaughtErrorEvents
UncaughtErrorEvent

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | UncaughtErrorEvents() Creates an UncaughtErrorEvents instance. | UncaughtErrorEvents
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. | EventDispatcher
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | EventDispatcher
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | EventDispatcher
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | EventDispatcher

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher
|  | uncaughtError | Dispatched when an error occurs and developer code doesn't detect and handle the error. | UncaughtErrorEvents

Constructor Detail

### UncaughtErrorEvents

()
Constructor

`public function UncaughtErrorEvents()`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10.1, AIR 2

Creates an UncaughtErrorEvents instance. Developer code shouldn't create UncaughtErrorEvents instances directly. To access an UncaughtErrorEvents object, use one of the following properties:

- `LoaderInfo.uncaughtErrorEvents`: to detect uncaught errors in code defined in the same SWF.
- `Loader.uncaughtErrorEvents`: to detect uncaught errors in code defined in the SWF loaded by a Loader object.

Related API Elements

LoaderInfo.uncaughtErrorEvents
Loader.uncaughtErrorEvents
Event Detail

### uncaughtError

Event

Event Object Type: `flash.events.UncaughtErrorEvent`
property UncaughtErrorEvent.type = `flash.events.UncaughtErrorEvent.UNCAUGHT_ERROR`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10.1, AIR 2

Dispatched when an error occurs and developer code doesn't detect and handle the error.

Defines the value of the `type` property of an `uncaughtError` event object.

Note: If in a try block, there is an event dispatcher that calls its event handler, the catch block doesn't catch the error if thrown in event handler. Any error thrown thereafter can be caught by listening to `LoaderInfo.uncaughtErrorEvents`.

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `true`
`cancelable` | `true`; cancelling the event prevents the uncaught error dialog from appearing in debugger runtime versions
`currentTarget` | The object that is actively processing the Event object with an event listener.
`error` | The uncaught error.
`target` | The LoaderInfo object associated with the SWF where the error happened.
`text` | Text error message.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00