ui.igValidator

ui.igValidator_image

Code Sample

 
    <!DOCTYPE html>
    <html>
    <head>
         <!--Ignite UI Required Combined CSS Files-->
        <link href="css/themes/infragistics/infragistics.theme.css" rel="stylesheet" />
        <link href="css/themes/infragistics/infragistics.ui.popover.css" rel="stylesheet" />
        <link href="css/themes/infragistics/infragistics.ui.notifier.css" rel="stylesheet" />
        <link href="css/themes/infragistics/infragistics.ui.editors.css" rel="stylesheet" />
        <link href="css/themes/infragistics/infragistics.ui.shared.css" rel="stylesheet" />
        <link href="css/structure/infragistics.css" rel="stylesheet" />

        <script src="js/modernizr-latest.js"></script>
        <script src="js/jquery.js"></script>
        <script src="js/jquery-ui.js"></script>

         <!--Ignite UI Required Combined JavaScript Files--> 
        <script src="js/infragistics.core.js"></script>
        <script src="js/infragistics.lob.js"></script>

        <script type="text/javascript">
   
            $(document).ready(function () {

                $('#validator').igTextEditor({
                    placeHolder: "User name"
                });

                  $('#validator').igValidator({
                    notificationOptions: {
                        direction: "right",
                        showIcon: "true",
                        mode:"popover"
                    },
                    required:true
                  });
            });


        </script>
    </head>
    <body>
        <input id="validator"/>
    </body>
    </html>

Related Samples

Related Topics

Dependencies

jquery-1.9.1.js
jquery.ui.core.js
jquery.ui.widget.js
infragistics.util.js
infragistics.util.jquery.js
infragistics.ui.widget.js
infragistics.ui.popover.js
infragistics.ui.notifier.js

Inherits

  • creditCard

    Type:
    enumeration
    Default:
    false

    Gets/Sets Credit Card number validation rule options. Note: This rule will only validate the checksum of the number using Luhn algorithm irregardless of card type.

    Members

    • boolean
    • Type:bool
    • A boolean value indicating if the field should be a valid Credit Card number.
    • object
    • Type:object
    • A configuration object with optional error message (e.g. creditCard: { errorMessage: "Enter a valid card number"} ).

    Code Sample

     
			//Initialize
			 $('.selector').igValidator({
				creditCard: true
			});
			//OR
			$('.selector').igValidator({
				creditCard: {
					errorMessage : "Enter a valid card number"
				}
			});
			//Get
			var creditCard = $('.selector').igValidator("option", "creditCard");
			//Set
			$('.selector').igValidator("option", 'creditCard', true);

  • custom

    Type:
    enumeration
    Default:
    null

    Gets/Sets a custom function to perform validation. Use 'this' to reference the calling validator and the value and optional field settings arguments to determine and return the state of the field.

    Members

    • function
    • Type:function
    • The function to call.
    • string
    • Type:string
    • Function name, must be in global namespace (window["name"]).
    • object
    • Type:object
    • A configuration object with method property being the function and optional error message.

    Code Sample

     
			//Initialize
			$('.selector').igValidator({
				custom: function(value, fieldOptions){
						return false;
					}
				});
			//OR
			$('.selector').igValidator({
				custom: {
					method: function(value, fieldOptions){
						return false;
					},
					errorMessage : "Value did not match"
				}
			});
			//Get
			var custom = $(".selector").igValidator("option", "custom");
			//Set
			var custom = {
				method: function (value, fieldOptions) {
					return false;
				},
				errorMessage: "This field is required."
			};
			$(".selector").igValidator("option", "custom", custom);

  • date

    Type:
    enumeration
    Default:
    false

    Gets/Sets date validation rule options. This can additionally help guide the valueRange validation. Note: Dependant on JavaScript Date parsing which will accept a wide range of values.

    Members

    • boolean
    • Type:bool
    • A boolean value indicating if the field should be a valid JavaScript Date or can be parsed as one.
    • object
    • Type:object
    • A configuration object with optional error message (e.g. date: { errorMessage: "Enter a valid number"} ).

    Code Sample

     
				//Initialize
				$('.selector').igValidator({
					date: true
				});
				//OR
				$('.selector').igValidator({
					date: {
						errorMessage: "Not a valid date"
					}
				});
				//Get
				var date = $(".selector").igValidator("option", "date");
				//Set
				$(".selector").igValidator("option", "date", true);

  • email

    Type:
    enumeration
    Default:
    false

    Gets/Sets email validation rule options. Uses a RegExp defined in the "$.ui.igValidator.defaults" object.

    Members

    • boolean
    • Type:bool
    • A boolean value indicating if the field should be an email.
    • object
    • Type:object
    • A configuration object with optional error message (e.g. email: { errorMessage: "Enter a valid email"} ).

    Code Sample

     
			//Initialize
			$('.selector').igValidator({
				email: true
			}
			//OR
			$('.selector').igValidator({
				email: {
					errorMessage : "Enter a valid email"
				}
			});
			//Get
			var email = $(".selector").igValidator("option", "email");
			//Set
			$(".selector").igValidator("option", "email", true);

  • equalTo

    Type:
    enumeration
    Default:
    null

    Gets/Sets a requirement for the value in this field to be the same as another input element or editor control.

    Members

    • string
    • Type:string
    • A valid jQuery selector for the target element.
    • object
    • Type:object
    • A reference to the jQuery object for the target or an object with selector property and custom errorMessage.

    Code Sample

     
			//Initialize
			$('.selector').igValidator({
				equalTo: "#field1"
			});
			//OR
			$('.selector').igValidator({
				equalTo: {
					selector: "#myEditor"
					errorMessage: "Value did not match."
				}
			});
			//Get
			var equalTo = $(".selector").igValidator("option", "equalTo");
			//Set
			$(".selector").igValidator("option", "equalTo", "#field1");

  • errorMessage

    Type:
    string
    Default:
    null

    Gets/Sets text for an error message to be used if none is set for the particular rule. Overrides default rule-specific error messages.

    Code Sample

     
			//Initialize
			$('.selector').igValidator({
				errorMessage: 'This field is required!'
			});

			//Get
			var errorMessage = $(".selector").igValidator("option", "errorMessage");

			//Set
			$(".selector").igValidator("option", "errorMessage", 'This field is required!');

  • executeAllRules

    Type:
    bool
    Default:
    false

    Gets/Sets if all rules for a field should be checked, so even if one fails the rest will continue executing.
    Note: This will not force checks on an empty field for rules that don't normally execute without a value.

    Code Sample

     
			//Initialize
			$('.selector').igValidator({
				executeAllRules: true
			});

			//Get
			var executeAllRules = $(".selector").igValidator("option", "executeAllRules");

			//Set
			$(".selector").igValidator("option", "executeAllRules", true);

  • fields

    Type:
    array
    Default:
    []
    Elements Type:
    object

    Gets a list of target field items describing each with validation options and a required selector. Fields can contain any of the validation rules and triggers but not other fields or event handlers.
    Applicable options are also inherited from the global control configuration if not set.

    Code Sample

     
				//Initialize
				$('.selector').igValidator({
					fields: [{
						selector: "#input1",
						required: true,
						number: true,
						onblur: false
					},
					{
						selector: "#input2",
						lengthRange: {
							min: 2,
							max: 10
						},
						onchange: true
					}]
				});

				//Get
				var fields = $(".selector").igValidator("option", "fields");

    • selector

      Type:
      enumeration
      Default:
      null

      Gets the target element (input or control target) to be validated. This field setting is required.

      Members

      • string
      • Type:string
      • A valid jQuery selector for the element.
      • object
      • Type:object
      • A reference to a jQuery object.

      Code Sample

       
			//Initialize
			$('.selector').igValidator({
				fields: [{
					selector: "#input1"
				},
				{
					selector: "#input2"
				}]
			});

  • language
    Inherited

    Type:
    string
    Default:
    "en"

    Set/Get the locale language setting for the widget.

    Code Sample

     
					//Initialize
				$(".selector").igValidator({
					language: "ja"
				});

				// Get
				var language = $(".selector").igValidator("option", "language");

				// Set
				$(".selector").igValidator("option", "language", "ja");

  • lengthRange

    Type:
    enumeration
    Default:
    null

    Gets/Sets a minimum and/or maximum length of text or number of selected items. Null or 0 values are ignored.

    Members

    • array
    • Type:array
    • An array of two numbers, where the first value is the minimum and the second is the maximum. (e.g. lengthRange: [ 1, 10] ).
    • object
    • Type:object
    • A configuration object with optional error message. Message strings can contain format items for min and max respectively (e.g. lengthRange: { min: 6, max: 20, errorMessage: "Password must be at least {0} long and no more than {1}." } ).

    Code Sample

     
			//Initialize
			$('.selector').igValidator({
				lengthRange: [2, 6]
			});
			//OR
			$('.selector').igValidator({
			lengthRange: {
				min: 2,
				max: 6,
				errorMessage: "Must be at least {0} long and no more than {1}."
			}
			});
			//Get
			var lengthRange = $(".selector").igValidator("option", "lengthRange");
			//Set
			$(".selector").igValidator("option", "lengthRange", [2, 6]);

  • locale
    Inherited

    Type:
    object
    Default:
    null

    Set/Get the locale setting for the widget.

    Code Sample

     
					//Initialize
				$(".selector").igValidator({
					locale: {}
				});

				// Get
				var locale = $(".selector").igValidator("option", "locale");

				// Set
				$(".selector").igValidator("option", "locale", {});

  • messageTarget

    Type:
    domelement
    Default:
    null

    Gets/Sets a custom jQuery element to be used for validation messages. That inner HTML of the target is modified, can be a SPAN, LABEL or DIV.

    Code Sample

     
			//Initialize
			$('.selector').igValidator({
				messageTarget: "#field1"
			});

			//Get
			var messageTarget = $(".selector").igValidator("option", "messageTarget");

			//Set
			$(".selector").igValidator("option", "messageTarget", "#field1");

  • notificationOptions

    Type:
    object
    Default:
    null

    Gets/Sets the options for the igNotifier used to show error messages.

    Code Sample

     
			//Initialize
				$('.selector').igValidator({
				notificationOptions: {
					direction: "right",
					showIcon: "true",
					mode:"popover",
					messages: {
						error: "This field is required!"
					}
				}
				});

				//Get
				var notificationOptions = $(".selector").igValidator("option", "notificationOptions");

				//Set
				var notificationOptions = {
					direction: "right",
					showIcon: "true",
					mode:"popover",
					messages: {
						error: "This field is required!"
					};

				$(".selector").igValidator("option", "notificationOptions", notificationOptions);

  • number

    Type:
    enumeration
    Default:
    false

    Gets/Sets number validation rule options. Default separators for decimals and thousands are '.' and ',' respectively and are defined in the "$.ui.igValidator.defaults" object.

    Members

    • boolean
    • Type:bool
    • A boolean value indicating if the field should be a number. Default separators are used.
    • object
    • Type:object
    • A configuration object with errorMessage, decimalSeparator and thousandsSeparator. Those properties are all optional.

    Code Sample

     
			//Initialize
			$('.selector').igValidator({
				number: true
			});
			//OR
			$('.selector').igValidator({
				number: {
					errorMessage : "Not a valid number",
					decimalSeparator: ".",
					thousandsSeparator: " "
				}
			});
			//Get
			var number = $(".selector").igValidator("option", "number");
			//Set
			$(".selector").igValidator("option", "number", true);

  • onblur

    Type:
    bool
    Default:
    true

    Gets/Sets whether validation is triggered when the editor loses focus.

    Code Sample

     
		//Initialize
		$('.selector').igValidator({
			onblur: true
		});

		//Get
		var onblur = $(".selector").igValidator("option", "onblur");

		//Set
		$(".selector").igValidator("option", "onblur", true);

  • onchange

    Type:
    bool
    Default:
    false

    Gets/Sets whether validation is triggered when the text in editor changes.
    Note that this is more appropriate for selection controls such as checkbox, combo or rating.
    As it can cause excessive messages with text-based fields, the initial validation can be delayed via the threshold option.

    Code Sample

     
			//Initialize
			$('.selector').igValidator({
				onchange: true
			});

			//Get
			var onchange = $(".selector").igValidator("option", "onchange");

			//Set
			$(".selector").igValidator("option", "onchange", true);

  • onsubmit

    Type:
    bool
    Default:
    true

    Gets/Sets whether validation is triggered when a form containing validation targets is submitting. If any of the validations fail, the submit action will be prevented.
    Note that this doesn't apply to the native JavaScript submit function, but will handle the jQuery equivalent and the browser default action.

    Code Sample

     
			//Initialize
			$('.selector').igValidator({
				onsubmit: true
			});

			//Get
			var onsubmit = $(".selector").igValidator("option", "onsubmit");

			//Set
			$(".selector").igValidator("option", "onsubmit", true);

  • optionalIndication

    Type:
    bool
    Default:
    false

    Gets/Sets the option to show a label indication next to optional fields.
    Note: Indicators are not supported on grouped controls such as checkbox or radio button sets and the igRating control.

    Code Sample

     
				//Initialize
				$('.selector').igValidator({
					optionalIndication: true
				});

				//Get
				var optionalIndication = $(".selector").igValidator("option", "optionalIndication");

				//Set
				$(".selector").igValidator("option", "optionalIndication", true);

  • pattern

    Type:
    enumeration
    Default:
    null

    Gets/Sets regular expression validation rule options.

    Members

    • string
    • Type:string
    • A string containing regular expression.
    • object
    • Type:object
    • A RegExp object or an object with expression and errorMessage properties.

    Code Sample

     
			//Initialize
			$(".selector").igValidator({
				pattern: "^\\d*\\.{0,1}\\d+$"
			});
			//OR
			$('.selector').igValidator({
				pattern: {
					expression: /^[a-z]+$/,
					errorMessage : "Value did not match"
				}
			});
			//Get
			var pattern = $(".selector").igValidator("option", "pattern");
			//Set
			$(".selector").igValidator("option", "pattern", "^\\d*\\.{0,1}\\d+$");

  • regional
    Inherited

    Type:
    enumeration
    Default:
    en-US

    Set/Get the regional setting for the widget.

    Code Sample

     
				//Initialize
				$(".selector").igValidator({
					regional: "ja"
				});
				// Get
				var regional = $(".selector").igValidator("option", "regional");
				// Set
				$(".selector").igValidator("option", "regional", "ja");

  • required

    Type:
    enumeration
    Default:
    false

    Gets/Sets option to validate if a value was entered (not empty text, selected item, etc.).

    Members

    • boolean
    • Type:bool
    • A boolean value indicating if the field is required.
    • object
    • Type:object
    • A configuration object with optional error message (e.g. required: { errorMessage: "Error!"} ).

    Code Sample

     
			//Initialize
			$('.selector').igValidator({
				required: true
			});
			//OR
			$('.selector').igValidator({
				required: {
					errorMessage: "This field is required."
				}
			});
			//Get
			var required = $(".selector").igValidator("option", "required");
			//Set
			$(".selector").igValidator("option", "required", true);

  • requiredIndication

    Type:
    bool
    Default:
    false

    Gets/Sets the option to show an asterisks indication next to required fields.
    Note: Indicators are not supported on grouped controls such as checkbox or radio button sets and the igRating control.

    Code Sample

     
				//Initialize
				$('.selector').igValidator({
					requiredIndication: true
				});

				//Get
				var requiredIndication = $(".selector").igValidator("option", "requiredIndication");

				//Set
				$(".selector").igValidator("option", "requiredIndication", true);

  • successMessage

    Type:
    string
    Default:
    null

    Gets/Sets text for a success message. Note that since there is no default, setting this message will enable showing success indication.

    Code Sample

     
			//Initialize
			$('.selector').igValidator({
				successMessage: "Well done!"
			});

			//Get
			var successMessage = $(".selector").igValidator("option", "successMessage");

			//Set
			$(".selector").igValidator("option", "successMessage", "Well done!");

  • threshold

    Type:
    number
    Default:
    -1

    Gets/Sets validation minimum input length. Validation won't be triggered for input before that value is reached on change and focus loss.
    Note: This will not affect required fields on form submit.

    Code Sample

     
			//Initialize
			$('.selector').igValidator({
				threshold: 1
			});

			//Get
			var threshold = $(".selector").igValidator("option", "threshold");

			//Set
			$(".selector").igValidator("option", "threshold", 1);

  • valueRange

    Type:
    enumeration
    Default:
    null

    Gets/Sets a minimum and/or maximum value. Null values are ignored.

    Members

    • array
    • Type:array
    • An array of two numbers or dates, where the first is the minimum and the second is the maximum. (e.g. valueRange: [ 1, 10] ).
    • object
    • Type:object
    • A configuration object with optional error message. Message strings can contain format items for min and max respectively (e.g. lengthRange: { min: 6, max: 20, errorMessage: "Value must be between {0} and {1}." } ).

    Code Sample

     
			//Initialize
				$('.selector').igValidator({
					valueRange: [2, 6]
			//OR
			$('.selector').igValidator({
				valueRange: {
					min: 2,
					max: 6,
					errorMessage: "Value must be between {0} and {1}."
				}
			});
			//Get
			var valueRange = $(".selector").igValidator("option", "valueRange");
			//Set
			var range = [2, 6];
			$(".selector").igValidator("option", "valueRange", range);

For more information on how to interact with the Ignite UI controls' events, refer to
Using Events in Ignite UI.

Note: Calling API methods programmatically does not raise events related to their operation unless specifically stated otherwise by the corresponding API documentation; those events are only raised by their respective user interaction.

Show Details

  • error

    Cancellable:
    false

    Event raised for invalid field after value was validated but before any action takes effect.
    Function takes arguments evt and ui.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • owner
          Type: Object

          Gets reference to the igValidator widget.

        • value
          Type: Object

          Gets the current value in target.

        • valid
          Type: Bool

          Determine the outcome of the validation.

        • message
          Type: String

          Get the formatted message text.

        • messages
          Type: Array

          Get all messages. May be more than one if executeAllRules is enabled.

        • rule
          Type: String

          Deprecated. Populated with the name of the rule that failed validation.

        • rules
          Type: Array

          Populated with the names of rule that failed validation.

        • fieldOptions
          Type: Object

          Populated with options for the specific field in the collection or null.

    Code Sample

     
				//Bind after initialization
				$(document).on("igvalidatorerror", ".selector", function (evt, ui) {
					//get reference to the igValidator widget
					ui.owner;
					//get current value in target
					ui.value;
					//get rules that failed validation
					ui.rules;
					//gets text of message
					ui.message;
					//get the options of the specific field in the collection
					ui.fieldOptions;
					});

				//Initialize
				$(".selector").igValidator({
					error: function (evt, ui) {
					...
					}
				});

  • errorHidden

    Cancellable:
    false

    Event which is raised after error message was hidden.

    Function takes arguments evt and ui.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • owner
          Type: Object

          Gets reference to the igValidator widget.

        • message
          Type: String

          Gets the text of message.

        • target
          Type: jQuery

          Gets reference to the target of the message.

        • fieldOptions
          Type: Object

          Populated with options for the specific field in the collection or null.

    Code Sample

     
			//Bind after initialization
			$(document).on("igvalidatorerrorhidden", ".selector", function (evt, ui) {
				//get reference to the igValidator widget
				ui.owner;
				//gets text of message
				ui.message;
				//get reference to the target of the message
				ui.target;
				//get the options of the specific field in the collection
				ui.fieldOptions;
		});

		//Initialize
		$(".selector").igValidator({
			errorHidden: function (evt, ui) {
			...
			}
		});

  • errorHiding

    Cancellable:
    true

    Event which is raised before error message is hidden.
    Return false in order to keep the error message displayed.

    Function takes arguments evt and ui.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • owner
          Type: Object

          Gets reference to the igValidator widget.

        • message
          Type: String

          Gets the text of message.

        • target
          Type: jQuery

          Gets reference to the target of the message.

        • fieldOptions
          Type: Object

          Populated with options for the specific field in the collection or null.

    Code Sample

     
				//Bind after initialization
				$(document).on("igvalidatorerrorhiding", ".selector", function (evt, ui) {
					//get reference to the igValidator widget
					ui.owner;
					//gets text of message
					ui.message;
					//get reference to the target of the message
					ui.target;
					//get the options of the specific field in the collection
					ui.fieldOptions;

				});

				//Initialize
				$(".selector").igValidator({
					errorHiding: function (evt, ui) {.
					...
					}
				});

  • errorShowing

    Cancellable:
    true

    Event which is raised before error message is displayed.
    Return false in order to prevent error message display.

    Function takes arguments evt and ui.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • owner
          Type: Object

          Gets reference to the igValidator widget.

        • message
          Type: String

          Gets the text of message.

        • target
          Type: jQuery

          Gets reference to the target of the message.

        • fieldOptions
          Type: Object

          Populated with options for the specific field in the collection or null.

    Code Sample

     
				//Bind after initialization
				$(document).on("igvalidatorerrorshowing", ".selector", function (evt, ui) {
					//get reference to the igValidator widget
					ui.owner;
					//gets text of message
					ui.message;
					//get reference to the target of the message
					ui.target;
					//get the options of the specific field in the collection
					ui.fieldOptions;
				});

				//Initialize
				$(".selector").igValidator({
					errorShowing: function (evt, ui) {
						...
					}
				});

  • errorShown

    Cancellable:
    false

    Event which is raised after error message was displayed.

    Function takes arguments evt and ui.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • owner
          Type: Object

          Gets reference to the igValidator widget.

        • message
          Type: String

          Gets the text of message.

        • target
          Type: jQuery

          Gets reference to the target of the message.

        • fieldOptions
          Type: Object

          Populated with options for the specific field in the collection or null.

    Code Sample

     
			//Bind after initialization
			$(document).on("igvalidatorerrorshown", ".selector", function (evt, ui) {
				//get reference to the igValidator widget
				ui.owner;
				//gets text of message
				ui.message;
				//get reference to the target of the message
				ui.target;
				//get the options of the specific field in the collection
				ui.fieldOptions;
		});

			//Initialize
			$(".selector").igValidator({
				errorShown: function (evt, ui) {
				...
				}
			});

  • formError

    Cancellable:
    false

    Event triggered on Validator instance level after failed validation on form submit event.

    Function takes arguments evt and ui.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • owner
          Type: Object

          Gets reference to the igValidator widget.

        • target
          Type: jQuery

          Gets reference to the event target form.

    Code Sample

     
			//Bind after initialization
			$(document).on("igvalidatorformerror", ".selector", function (evt, ui) {
					//get reference to the igValidator widget
					ui.owner;
					//get reference of the event target form
					ui.target
				});

			//Initialize
			$(".selector").igValidator({
				formError: function (evt, ui) {
				...
				}
			});

  • formSuccess

    Cancellable:
    false

    Event triggered on Validator instance level after successful validation on form submit event.

    Function takes arguments evt and ui.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • owner
          Type: Object

          Gets reference to the igValidator widget.

        • target
          Type: jQuery

          Gets reference to the event target form.

    Code Sample

     
			//Bind after initialization
			$(document).on("igvalidatorformsuccess", ".selector", function (evt, ui) {
					//get reference to the igValidator widget
					ui.owner;
					//get reference of the event target form
					ui.target;
				});

				//Initialize
				$(".selector").igValidator({
					formSuccess: function (evt, ui) {
					...
					}
				});

  • formValidated

    Cancellable:
    false

    Event triggered on Validator instance level after validation on form submit event..

    Function takes arguments evt and ui.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • owner
          Type: Object

          Gets reference to the igValidator widget.

        • target
          Type: jQuery

          Gets reference to the event target form.

        • valid
          Type: Bool

          Determine the outcome of the validation.

    Code Sample

     
			//Bind after initialization
			$(document).on("igvalidatorformvalidated", ".selector", function (evt, ui) {
					//get reference to the igValidator widget
					ui.owner;
					//get reference of the event target form
					ui.target;
					//determine the outcome of the validation
					ui.valid;
				});

			//Initialize
			$(".selector").igValidator({
			formValidated: function (evt, ui) {
				...
				}
			});

  • formValidating

    Cancellable:
    true

    Event triggered on Validator instance level before handling a form submit event.
    Return false to cancel to skip validating and potentially allow the submit if no other other validators return error.

    Function takes arguments evt and ui.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • owner
          Type: Object

          Gets reference to the igValidator widget.

        • target
          Type: jQuery

          Gets reference to the event target form.

    Code Sample

     
				//Bind after initialization
				$(document).on("igvalidatorformvalidating", ".selector", function (evt, ui) {
					//get reference to the igValidator widget
					ui.owner;
					//get reference of the event target form
					ui.target;
				});

				//Initialize
				$(".selector").igValidator({
					formValidating: function (evt, ui) {
					...
					}
				});

  • success

    Cancellable:
    false

    Event raised for valid field after value was validated but before any action takes effect.
    Function takes arguments evt and ui.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • owner
          Type: Object

          Gets reference to the igValidator widget.

        • value
          Type: Object

          Gets the current value in target.

        • valid
          Type: Bool

          Determine the outcome of the validation.

        • message
          Type: String

          Get the formatted message text, if any.

        • fieldOptions
          Type: Object

          Populated with options for the specific field in the collection or null.

    Code Sample

     
				//Bind after initialization
				$(document).on("igvalidatorsuccess", ".selector", function (evt, ui) {
					//get reference to the igValidator widget
					ui.owner;
					//get current value in target
					ui.value;
					//gets text of message, if any
					ui.message;
					//get the options of the specific field in the collection
					ui.fieldOptions;
				});

				//Initialize
				$(".selector").igValidator({
					success: function (evt, ui) {
					...
					}
				});

  • successHidden

    Cancellable:
    false

    Event which is raised after success message was hidden.

    Function takes arguments evt and ui.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • owner
          Type: Object

          Gets reference to the igValidator widget.

        • message
          Type: String

          Gets the text of message.

        • target
          Type: jQuery

          Gets reference to the target of the message.

        • fieldOptions
          Type: Object

          Populated with options for the specific field in the collection or null.

    Code Sample

     
			//Bind after initialization
			$(document).on("igvalidatorsuccesshidden", ".selector", function (evt, ui) {
				//get reference to the igValidator widget
				ui.owner;
				//gets text of message
				ui.message;
				//get reference to the target of the message
				ui.target;
				//get the options of the specific field in the collection
				ui.fieldOptions;
				});

				//Initialize
				$(".selector").igValidator({
					successHidden: function (evt, ui) {
					...
					}
				});

  • successHiding

    Cancellable:
    true

    Event which is raised before success message is hidden.
    Return false in order to keep success message displayed.

    Function takes arguments evt and ui.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • owner
          Type: Object

          Gets reference to the igValidator widget.

        • message
          Type: String

          Gets the text of message.

        • target
          Type: jQuery

          Gets reference to the target of the message.

        • fieldOptions
          Type: Object

          Populated with options for the specific field in the collection or null.

    Code Sample

     
				//Bind after initialization
				$(document).on("igvalidatorsuccesshiding", ".selector", function (evt, ui) {
					//get reference to the igValidator widget
					ui.owner;
					//gets text of message
					ui.message;
					//get reference to the target of the message
					ui.target;
					//get the options of the specific field in the collection
					ui.fieldOptions;
					});

					//Initialize
					$(".selector").igValidator({
						successHiding: function (evt, ui) {
						...
						}
					});

  • successShowing

    Cancellable:
    true

    Event which is raised before success message is displayed.
    Return false in order to prevent success message display.

    Function takes arguments evt and ui.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • owner
          Type: Object

          Gets reference to the igValidator widget.

        • message
          Type: String

          Gets the text of message.

        • target
          Type: jQuery

          Gets reference to the target of the message.

        • fieldOptions
          Type: Object

          Populated with options for the specific field in the collection or null.

    Code Sample

     
				//Bind after initialization
				$(document).on("igvalidatorsuccessshowing", ".selector", function (evt, ui) {
					//get reference to the igValidator widget
					ui.owner;
					//gets text of message
					ui.message;
					//get reference to the target of the message
					ui.target;
					//get the options of the specific field in the collection
					ui.fieldOptions;
				});

				//Initialize
				$(".selector").igValidator({
					successShowing: function (evt, ui) {
					...
					}
				});

  • successShown

    Cancellable:
    false

    Event which is raised after success message was displayed.

    Function takes arguments evt and ui.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • owner
          Type: Object

          Gets reference to the igValidator widget.

        • message
          Type: String

          Gets the text of message.

        • target
          Type: jQuery

          Gets reference to the target of the message.

        • fieldOptions
          Type: Object

          Populated with options for the specific field in the collection or null.

    Code Sample

     
				//Bind after initialization
				$(document).on("igvalidatorsuccessshown", ".selector", function (evt, ui) {
						//get reference to the igValidator widget
						ui.owner;
						//gets text of message
						ui.message;
						//get reference to the target of the message
						ui.target;
						//get the options of the specific field in the collection
						ui.fieldOptions;
					});

					//Initialize
					$(".selector").igValidator({
						successShown: function (evt, ui) {
						...
						}
					});

  • validated

    Cancellable:
    false

    Event which is raised after value was validated but before any action takes effect.

    Function takes arguments evt and ui.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • owner
          Type: Object

          Gets reference to the igValidator widget.

        • value
          Type: Object

          Gets the current value in target.

        • valid
          Type: Bool

          Determine the outcome of the validation.

        • message
          Type: String

          Get the formatted message text, if any.

        • messages
          Type: Array

          Get all messages, if any. May be more than one if executeAllRules is enabled.

        • rule
          Type: String

          Deprecated. Populated with the name of the rule that failed validation, if any.

        • rules
          Type: Array

          Populated with the names of rule that failed validation, if any.

        • fieldOptions
          Type: Object

          Populated with options for the specific field in the collection or null.

    Code Sample

     
			//Bind after initialization
			$(document).on("igvalidatorvalidated", ".selector", function (evt, ui) {
				//get reference to the igValidator widget
				ui.owner;
				//get current value in target
				ui.value;
				//determine the outcome of the validation
				ui.valid;
			});

			//Initialize
			$(".selector").igValidator({
				validated: function (evt, ui) {
				...
				}
			});

  • validating

    Cancellable:
    true

    Event which is raised on validation before default validation logic is applied.
    Return false in order to cancel the event and consider the field valid.

    Function takes arguments evt and ui.

    • evt
      Type: Event

      JQuery event object.

    • ui
      Type: Object

        • owner
          Type: Object

          Gets reference to the igValidator widget.

        • value
          Type: Object

          Gets the current value in target.

        • fieldOptions
          Type: Object

          Populated with options for the specific field in the collection or null.

    Code Sample

     
				//Bind after initialization
				$(document).on("igvalidatorvalidating", ".selector", function (evt, ui) {
					//get reference to the igValidator widget
					ui.owner;
					//get current value in target
					ui.value ;
					//get the options of the specific field in the collection
					ui.fieldOptions;
				});

				//Initialize
				$(".selector").igValidator({
					validating: function (evt, ui) {
					...
					}
				});

  • addField

    .igValidator( "addField", field:object );

    Adds an new input to the fields collection and initializes it with the validator. Note: Additional fields are only accepted if the validator has been created with the collection.

    • field
    • Type:object
    • An object with the field selector and options.

    Code Sample

     
			var field = {
				selector: "#input1",
				required: true,
				number: true,
				onblur: false
			};
			$(".selector").igValidator("addField",field);

  • changeGlobalLanguage
    Inherited

    .igValidator( "changeGlobalLanguage" );

    Changes the widget language to global language. Global language is the value in $.ig.util.language.

    Code Sample

     
				$(".selector").igValidator("changeGlobalLanguage");

  • changeGlobalRegional
    Inherited

    .igValidator( "changeGlobalRegional" );

    Changes the widget regional settins to global regional settings. Global regional settings are container in $.ig.util.regional.

    Code Sample

     
				$(".selector").igValidator("changeGlobalRegional");

  • changeLocale
    Inherited

    .igValidator( "changeLocale", $container:object );

    Changes the all locales contained into a specified container to the language specified in options.language
    Note that this method is for rare scenarios, use language or locale option setter.

    • $container
    • Type:object
    • Optional parameter - if not set it would use the element of the widget as $container.

    Code Sample

     
				$(".selector").igValidator("changeLocale");

  • destroy

    .igValidator( "destroy" );

    Destroys the validator widget.

    Code Sample

     
			$(".selector").igValidator("destroy");

  • getErrorMessages

    .igValidator( "getErrorMessages", [field:object] );
    Return Type:
    array
    Return Type Description:
    An array of all current error messages.

    Gets all current error messages for invalid field(s). Note that this method does not validate and states and messages are only updated on validation, so
    this can be used on formValidated event or after validate/isValid method calls.

    • field
    • Type:object
    • Optional
    • Optional field object, selector or zero-based index for a single field to get error message for.

    Code Sample

     
				var getErrorMessages = $(".selector").igValidator("getErrorMessages","#field1");

  • hide

    .igValidator( "hide", [field:object] );

    Hide any possible message(s) (either messageTarget or igNotifier).
    Note: When the validator has a fields collection, not passing a field will hide messages on all fields.

    • field
    • Type:object
    • Optional
    • Optional field object, its selector or zero-based index to hide message for.

    Code Sample

     
				$(".selector").igValidator("hide");

  • isMessageDisplayed

    .igValidator( "isMessageDisplayed", [field:object] );
    Return Type:
    bool
    Return Type Description:
    True if there is a currently visible message.

    Check for currently displayed message(s). Takes an optional field.
    Note: When the validator has a fields collection, not passing a field will return a cumulative true even if just one field has a visible message.

    • field
    • Type:object
    • Optional
    • Optional field object, selector or zero-based index for a single field to get error message for.

    Code Sample

     
				var isMessageDisplayed = $(".selector").igValidator("isMessageDisplayed","#field1");

  • isValid

    .igValidator( "isValid", [field:object] );
    Return Type:
    bool
    Return Type Description:
    True if the field(s) passed all checks.

    Trigger validation but do not display error messages.

    • field
    • Type:object
    • Optional
    • Optional field object, its selector or zero-based index to check. Only has effect with fields collection and skips other fields.

    Code Sample

     
			var isValid = $(".selector").igValidator("isValid");

  • notifier

    .igValidator( "notifier", [field:object] );
    Return Type:
    object
    Return Type Description:
    Reference to igNotifier or null on incorrect field.

    Gets the notifier for the igValidator or for a single filed.

    • field
    • Type:object
    • Optional
    • Optional field object, its selector or zero-based index to get notifier for.

    Code Sample

     
			var notifier = $(".selector").igValidator("notifier");

  • removeField

    .igValidator( "removeField", field:object );

    Removes an input from the fields collection.

    • field
    • Type:object
    • The field object to remove, its zero-based index or selector.

    Code Sample

     
			$(".selector").igValidator("removeField","#input1");

  • updateField

    .igValidator( "updateField", field:object, [fieldOptions:object] );

    Updates a field in the validator collection. Used to reinitialize field in case a control has been created after the validator or to pass in new options.

    • field
    • Type:object
    • The field object to update, its zero-based index or selector.
    • fieldOptions
    • Type:object
    • Optional
    • New options to apply to the field.

    Code Sample

     
			var newOptions = {
				required: true,
				number: true,
				onblur: false
			};

			$(".selector").igValidator("updateField","#input1", newOptions);

  • validate

    .igValidator( "validate", [field:object] );
    Return Type:
    bool
    Return Type Description:
    True if the field(s) passed all checks.

    Trigger validation and show errors for invalid fields.

    • field
    • Type:object
    • Optional
    • Optional field object, its selector or zero-based index to check. Only has effect with fields collection and skips other fields.

    Code Sample

     
			var validate = $(".selector").igValidator("validate");

  • ui-igvalidator-optional-indication

    Class applied to the indication span next to optional fields .

  • ui-igvalidator-required-indication

    Class applied to the asterisks indication span next to required fields .

  • ui-igvalidator-target

    Class applied to the target element with validation. Has no visual effect.

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.