Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
ValidationResultEvent

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

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.

See also

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

Public Properties

| Property | Defined By
--- | --- | ---
|  | 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

Public Methods

| Method | Defined By
--- | --- | ---
|  | ValidationResultEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, field:String = null, results:Array = null) Constructor. | ValidationResultEvent

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.

See also

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.

Sun Mar 5 2017, 03:42 PM +11:00