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

Package | mx.validators
Class | public class ValidationResult
Inheritance | ValidationResult Object
Subclasses | RegExpValidationResult

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The ValidationResult class contains the results of a validation.

The ValidationResultEvent class defines the event object that is passed to event listeners for the `valid` and `invalid` validator events. The class also defines the `results` property, which contains an Array of ValidationResult objects, one for each field examined by the validator. This lets you access the ValidationResult objects from within an event listener.

See also

mx.events.ValidationResultEvent

Public Properties

| Property | Defined By
--- | --- | ---
|  | errorCode : String The validation error code if the value of the isError property is true. | ValidationResult
|  | errorMessage : String The validation error message if the value of the isError property is true. | ValidationResult
|  | isError : Boolean Contains true if the field generated a validation failure. | ValidationResult
|  | subField : String The name of the subfield that the result is associated with. | ValidationResult

Public Methods

| Method | Defined By
--- | --- | ---
|  | ValidationResult(isError:Boolean, subField:String, errorCode:String, errorMessage:String) Constructor | ValidationResult

Property Detail

errorCode | property

`public var errorCode:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The validation error code if the value of the `isError` property is `true`.

errorMessage | property |

`public var errorMessage:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The validation error message if the value of the `isError` property is `true`.

isError | property |

`public var isError:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Contains `true` if the field generated a validation failure.

subField | property |

`public var subField:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The name of the subfield that the result is associated with. Some validators, such as CreditCardValidator and DateValidator, validate multiple subfields at the same time.

Constructor Detail

ValidationResult | () | Constructor

`public function ValidationResult(isError:Boolean, subField:String, errorCode:String, errorMessage:String)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor

Parameters

| `isError:Boolean` — Pass `true` if there was a validation error.
| `subField:String` — Name of the subfield of the validated Object.
| `errorCode:String` — Validation error code.
| `errorMessage:String` — Validation error message.

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