Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.validators 
RegExpValidationResult 
Packagemx.validators
Classpublic class RegExpValidationResult
InheritanceRegExpValidationResult Inheritance ValidationResult Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The RegExpValidator class dispatches the valid and invalid events. For an invalid event, the event object is an instance of the ValidationResultEvent class, and the ValidationResultEvent.results property contains an Array of ValidationResult objects.

However, for a valid event, the ValidationResultEvent.results property contains an Array of RegExpValidationResult objects. The RegExpValidationResult class is a child class of the ValidationResult class, and contains additional properties used with regular expressions.

See also



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritederrorCode : String
The validation error code if the value of the isError property is true.
ValidationResult
 InheritederrorMessage : String
The validation error message if the value of the isError property is true.
ValidationResult
 InheritedisError : Boolean
Contains true if the field generated a validation failure.
ValidationResult
  matchedIndex : int
An integer that contains the starting index in the input String of the match.
RegExpValidationResult
  matchedString : String
A String that contains the substring of the input String that matches the regular expression.
RegExpValidationResult
  matchedSubstrings : Array
An Array of Strings that contains parenthesized substring matches, if any.
RegExpValidationResult
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedsubField : String
The name of the subfield that the result is associated with.
ValidationResult
Public Methods
 MethodDefined By
  
RegExpValidationResult(isError:Boolean, subField:String = "", errorCode:String = "", errorMessage:String = "", matchedString:String = "", matchedIndex:int = 0, matchedSubstrings:Array = null)
Constructor
RegExpValidationResult
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

matchedIndex

property
public var matchedIndex:int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

An integer that contains the starting index in the input String of the match.

matchedString

property 
public var matchedString:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

A String that contains the substring of the input String that matches the regular expression.

matchedSubstrings

property 
public var matchedSubstrings:Array

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

An Array of Strings that contains parenthesized substring matches, if any. If no substring matches are found, this Array is of length 0. Use matchedSubStrings[0] to access the first substring match.

Constructor Detail

RegExpValidationResult

()Constructor
public function RegExpValidationResult(isError:Boolean, subField:String = "", errorCode:String = "", errorMessage:String = "", matchedString:String = "", matchedIndex:int = 0, matchedSubstrings:Array = null)

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 (default = "") — Name of the subfield of the validated Object.
 
errorCode:String (default = "") — Validation error code.
 
errorMessage:String (default = "") — Validation error message.
 
matchedString:String (default = "") — Matching substring.
 
matchedIndex:int (default = 0) — Index of the matching String.
 
matchedSubstrings:Array (default = null) — Array of substring matches.