mx.events

# ValidationResultEvent - AS3 Flex

Package | mx.events
Class | public class ValidationResultEvent
Inheritance | ValidationResultEvent Event Object

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The ValidationResultEvent class represents the event object passed to the listener for the `valid` validator event or the `invalid` validator event.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

mx.validators.Validator
mx.validators.ValidationResult
mx.validators.RegExpValidationResult

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | field : String The name of the field that failed validation and triggered the event. | ValidationResultEvent
|  | message : String [read-only] A single string that contains every error message from all of the ValidationResult objects in the results Array. | ValidationResultEvent
|  | results : Array An array of ValidationResult objects, one per validated field. | ValidationResultEvent
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | ValidationResultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, field:String = null, results:Array = null) Constructor. | ValidationResultEvent
|  | clone():Event Duplicates an instance of an Event subclass. | Event
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | 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
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns a string containing all the properties of the Event object. | Event
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | INVALID : String = "invalid" [static] The ValidationResultEvent.INVALID constant defines the value of the type property of the event object for an invalid event. | ValidationResultEvent
|  | VALID : String = "valid" [static] The ValidationResultEvent.VALID constant defines the value of the type property of the event object for a validevent. | ValidationResultEvent

Property Detail

### field

property

`public var field:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The name of the field that failed validation and triggered the event.

### message

property

`message:String` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

A single string that contains every error message from all of the ValidationResult objects in the results Array.

Implementation
`public function get message():String`

### results

property

`public var results:Array`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

An array of ValidationResult objects, one per validated field.

Related API Elements

mx.validators.ValidationResult
Constructor Detail

### ValidationResultEvent

()
Constructor

`public function ValidationResultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, field:String = null, results:Array = null)`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `type:String` — The event type; indicates the action that caused the event.
| `bubbles:Boolean` (default = `false`)`` — Specifies whether the event can bubble up the display list hierarchy.
| `cancelable:Boolean` (default = `false`)`` — Specifies whether the behavior associated with the event can be prevented.
| `field:String` (default = `null`)`` — The name of the field that failed validation and triggered the event.
| `results:Array` (default = `null`)`` — An array of ValidationResult objects, one per validated field.

Constant Detail

### INVALID

Constant

`public static const INVALID:String = "invalid"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The `ValidationResultEvent.INVALID` constant defines the value of the `type` property of the event object for an `invalid` event. The value of this constant is "invalid".

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`field` | The name of the field that failed validation.
`message` | A single string that contains every error message from all of the ValidationResult objects in the results Array.
`results` | An array of ValidationResult objects, one per validated field.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

### VALID

Constant

`public static const VALID:String = "valid"`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The `ValidationResultEvent.VALID` constant defines the value of the `type` property of the event object for a `valid`event. The value of this constant is "valid".

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`field` | An empty String.
`message` | An empty String.
`results` | An empty Array.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

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