Specifies that the formatting of the value supplied by the user in the specified input field must match the specified pattern. If validation fails, the body of this tag is evaluated.

Be sure the clientvalidate attribute of the input tag you are validating does not equal "none." The clientvalidate attribute of the form tag containing the input tag should be set to "true."

Contexts

Valid in:

form

<domino:validatepattern
name="input tag name"
pattern="valid pattern for matching values"
message="message to display if validation fails"
msgkey="message bundle key"
bundle="name of .properties file bundle"
locale="<languageCode>_<countryCode>"
alert="true|false"
onalert="alert dialog box message"
debug="true|false"
onfailure="inline|exception"
time="true|false"
The HTML tag attributes listed below>

alert

If true and client-side validation is enabled (form tag's clientvalidate attribute = true), displays a pop-up alert dialog box when a validation error is encountered. The contents of the dialog box are supplied by a search performed in the following sequence:

1) onalert attribute value

2) msgkey attribute value

3) message attribute value

4) body of this tag


Default is false. Optional.

Name of the message bundle to use if the msgkey attribute is specified. The default search sequence is followed and if no message is found, the default resource bundle name, messages, is used. You cannot supply a value for this attribute unless you also specify a value for the msgkey attribute. Optional.

Locale to use to locate the proper message bundle. If specified, overrides the locale that the browser specifies in the AcceptLang string. Use the following syntax: "<languageCode>_<countryCode>". See See Locale codes for more details. By default, uses the first locale specified in the AcceptLang string for the browser. You cannot supply a value for this attribute unless you also specify a value for the msgkey attribute. Optional.

Message that the validatesummary tag displays if validation fails. The content of this attribute is treated as pass-thru HTML. Optional.

Name of a key in the associated message bundle. Optional.

Name of the input tag to perform validation on (equals the name attribute of the corresponding input tag). Required.

Message to display in the alert dialog box that displays when client side validation fails. Supplying a value for this attribute automatically sets the alert attribute to true. Optional.

String made up of the characters which represent the allowable syntax for an entry. Accepts any of the characters listed in the Regular expression syntax section. Required.

HTML Attributes

See the Common HTML tag attributes section for definitions of the following standard HTML tag attributes:

class

style

Characters

Character	Definition
unicodeChar	Matches any identical unicode character
\	Quotes a meta-character (like '*')
\\	Matches a single '\' character
\0nnn	Matches a given octal character
\xhh	Matches a given 8-bit hexadecimal character
\uhhhh	Matches a given 16-bit hexadecimal character
\t	Matches an ASCII tab character
\n	Matches an ASCII newline character
\r	Matches an ASCII return character
\f	Matches an ASCII form feed character

Character classes

Class	Character type
[abc]	Simple character class
[a-zA-Z]	Character class with ranges
[^abc]	Negated character class

Standard POSIX character classes

Class	Character type
[:alnum:]	Alphanumeric
[alpha:]	Alphabetic
[:blank:]	Space and tab
[:cntrl:]	Control
[:digit:]	Numeric
[:graph;]	Printable, but not visible (a space, for example)
[:lower:]	Lower-case alphabetic
[:print:]	Printable (not control characters)
[:punct:]	Punctuation (not letters, digits, controls, or spaces)
[:space:]	Space (tabs, line feeds, carriage returns, and spaces, for example)
[:upper:]	Upper-case alphabetic
[:xdigit:]	Hexadecimal digits

Non-standard POSIX-sytle character classes

Class	Character type
[:javastart:]	Beginning of a Java identifier
[:javapart:]	Part of a Java identifier

Predefined classes

Class	Definition
.	Matches any character other than newline
\w	Matches a "word" character (alphanumeric plus "_")
\W	Matches a non-word character
\s	Matches a whitespace character
\S	Matches a non-whitespace character
\d	Matches a digit character
\D	Matches a non-digit character

Boundary matchers

Operator	Definition
^	Matches only at the beginning of a line
$	Matches only at the end of a line
\b	Matches only at a word boundary
\B	Matches only at a non-word boundary

Closures

All closure operators (+, *, ?, {m,n}) are greedy by default, meaning that they match as many elements of the string as possible without causing the overall match to fail. A reluctant closure matches as few elements of the string as possible when finding matches. If you want a closure to be reluctant, you can simply follow it with a '?'. {m,n} closures do not currently support reluctancy.

Greedy closures

Operator	Definition
A*	Matches A zero or more times (greedy)
A+	Matches A 1 or more times (greedy)
A?	Matches A zero or 1 times (greedy)
A{n}	Matches A exactly n times (greedy)
A{n, }	Matches A at least n times (greedy)
A{n,m}	Matches A at least n but not more than m times (greedy)

Reluctant closures

Operator	Definition
A*?	Matches A zero or more times (reluctant)
A+?	Matches A 1 or more times (reluctant)
A??	Matches A zero or 1 times (reluctant)

Logical operators

Operator	Definition
AB	Matches A followed by B
A|B	Matches either A or B
(A)	Used for subexpression grouping

Backreferences

A "backreference" refers to the contents of a parenthesized expression within a regular expression. The first backreference in a regular expression is denoted by \1, the second by \2 and so on. The following expression will match any string in the form n=n (like 0=0 or 2=2):

([0-9]+)=\1

Operator	Definition
\1	Backreference to 1st parenthesized subexpression
\2	Backreference to 2nd parenthesized subexpression
\3	Backreference to 3rd parenthesized subexpression
\4	Backreference to 4th parenthesized subexpression
\5	Backreference to 5th parenthesized subexpression
\6	Backreference to 6th parenthesized subexpression
\7	Backreference to 7th parenthesized subexpression
\8	Backreference to 8th parenthesized subexpression
\9	Backreference to 9th parenthesized subexpression

The Domtags tag library

Glossary