JQuery Validation Library (Document! X Sample)
jQuery.validator Namespace / options type
In This Topic
    options type Members
    In This Topic

    The following tables list the members exposed by options.

    public OptionEnables debug mode. If true, the form is not submitted and certain errors are displayed on the console (requires Firebug or Firebug lite). Try to enable when a form is just submitted instead of validation stopping the submit.  
    public OptionUse this class to create error labels, to look for existing error labels and to add it to invalid elements.  
    public OptionHide and show this container when validating.  
    public OptionUse this element type to create error messages and to look for existing error messages. The default, "label", has the advantage of creating a meaningful link between error message and invalid field using the for attribute (which is always used, no matter the element type).  
    public OptionHide and show this container when validating.  
    public OptionCustomize placement of created error labels. First argument: The created error label as a jQuery object. Second argument: The invalid element as a jQuery object.  
    public OptionIf enabled, removes the errorClass from the invalid elements and hides all errors messages whenever the element is focused. Avoid combination with focusInvalid.  
    public OptionFocus the last active or first invalid element on submit via validator.focusInvalid(). The last active element is the one that had focus when the form was submitted, avoiding to steal its focus. If there was no element focused, the first one in the form gets it, unless this option is turned off.  
    public OptionSpecify grouping of error messages. A group consists of an arbitrary group name as the key and a space separated list of element names as the value. Use errorPlacement to control where the group message is placed.  
    public OptionHow to highlight invalid fields. Override to decide which fields and how to highlight.  
    public OptionElements to ignore when validating, simply filtering them out. jQuery's not-method is used, therefore everything that is accepted by not() can be passed as this option. Inputs of type submit and reset are always ignored, so are disabled elements.  
    public OptionSet to skip reading messages from the title attribute, helps to avoid issues with Google Toolbar; default is false for compability, the message-from-title is likely to be completely removed in a future release  
    public OptionCallback for custom code when an invalid form is submitted. Called with a event object as the first argument, and the validator as the second.  
    public OptionKey/value pairs defining custom messages. Key is the name of an element, value the message to display for that element. Instead of a plain message another map with specific messages for each rule can be used. Overrides the title attribute of an element or the default message for the method (in that order). Each message can be a String or a Callback. The callback is called in the scope of the validator and with the rule's parameters as the first and the element as the second arugment, it must return a String to display as the message.  
    public OptionValidate checkboxes and radio buttons on click.  
    public OptionValidate elements (except checkboxes/radio buttons) on blur. If nothing is entered, all rules are skipped, except when the field was already marked as invalid.  
    public OptionValidate elements on keyup. As long as the field is not marked as invalid, nothing happens. Otherwise, all rules are checked on each key up event.  
    public OptionValidate the form on submit. Set to false to use only other events for validation.  
    public OptionKey/value pairs defining custom rules. Key is the name of an element (or a group of checkboxes/radio buttons), value is an object consisting of rule/parameter pairs or a plain String. Can be combined with class/attribute/data rules. Each rule can be specified as having a depends-property to apply the rule only in certain conditions. See the second example below for details.  
    public OptionA custom message display handler. Gets the map of errors as the first argument and and array of errors as the second, called in the context of the validator object. The arguments contain only those elements currently validated, which can be a single element when doing validation onblur/keyup. You can trigger (in addition to your own messages) the default behaviour by calling this.defaultShowErrors().  
    public OptionCallback for handling the actual submit when the form is valid. Gets the form as the only argument. Replaces the default submit. The right place to submit a form via Ajax after it validated.  
    public OptionIf specified, the error label is displayed to show a valid element. If a String is given, its added as a class to the label. If a Function is given, its called with the label (as a jQuery object) as its only argument. That can be used to add a text like "ok!".  
    public OptionCalled to revert changes made by option highlight, same arguments as highlight.  
    public OptionThis class is added to an element after it was validated and considered valid.  
    public OptionWrap error labels with the specified element. Useful in combination with errorLabelContainer to create a list of error messages.  
    See Also