2 // System.Web.UI.WebControls.BaseValidator
5 // Chris Toshok (toshok@novell.com)
7 // (C) 2005 Novell, Inc (http://www.novell.com)
9 // Permission is hereby granted, free of charge, to any person obtaining
10 // a copy of this software and associated documentation files (the
11 // "Software"), to deal in the Software without restriction, including
12 // without limitation the rights to use, copy, modify, merge, publish,
13 // distribute, sublicense, and/or sell copies of the Software, and to
14 // permit persons to whom the Software is furnished to do so, subject to
15 // the following conditions:
17 // The above copyright notice and this permission notice shall be
18 // included in all copies or substantial portions of the Software.
20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 using System.Web.Configuration;
30 using System.ComponentModel;
32 using System.Reflection;
33 using System.Collections;
34 using System.Security.Permissions;
36 namespace System.Web.UI.WebControls {
39 [AspNetHostingPermission (SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
40 [AspNetHostingPermission (SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
42 [DefaultProperty("ErrorMessage")]
43 [Designer("System.Web.UI.Design.WebControls.BaseValidatorDesigner, " + Consts.AssemblySystem_Design, "System.ComponentModel.Design.IDesigner")]
44 public abstract class BaseValidator : Label, IValidator
50 protected BaseValidator ()
53 this.ForeColor = Color.Red;
59 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
61 [EditorBrowsable(EditorBrowsableState.Never)]
62 public override string AssociatedControlID {
64 return base.AssociatedControlID;
67 base.AssociatedControlID = value;
74 public virtual string ValidationGroup {
75 get { return ViewState.GetString ("ValidationGroup", String.Empty); }
76 set { ViewState["ValidationGroup"] = value; }
80 [DefaultValue (false)]
81 public bool SetFocusOnError {
82 get { return ViewState.GetBool ("SetFocusOnError", false); }
83 set { ViewState["SetFocusOnError"] = value; }
86 /* listed in corcompare */
87 [MonoTODO("Why override?")]
88 [PersistenceMode (PersistenceMode.InnerDefaultProperty)]
90 public override string Text
92 get { return base.Text; }
93 set { base.Text = value; }
98 [IDReferenceProperty (typeof (Control))]
101 [TypeConverter(typeof(System.Web.UI.WebControls.ValidatedControlConverter))]
103 [WebSysDescription ("")]
104 [WebCategory ("Behavior")]
105 public string ControlToValidate {
106 get { return ViewState.GetString ("ControlToValidate", String.Empty); }
107 set { ViewState ["ControlToValidate"] = value; }
116 [DefaultValue(ValidatorDisplay.Static)]
117 [WebSysDescription ("")]
118 [WebCategory ("Appearance")]
119 public ValidatorDisplay Display {
120 get { return (ValidatorDisplay)ViewState.GetInt ("Display", (int)ValidatorDisplay.Static); }
121 set { ViewState ["Display"] = (int)value; }
128 [WebSysDescription ("")]
129 [WebCategory ("Behavior")]
130 public bool EnableClientScript {
131 get { return ViewState.GetBool ("EnableClientScript", true); }
132 set { ViewState ["EnableClientScript"] = value; }
135 public override bool Enabled {
136 get { return ViewState.GetBool ("Enabled", true); }
137 set { ViewState ["Enabled"] = value; }
147 [WebSysDescription ("")]
148 [WebCategory ("Appearance")]
154 string ErrorMessage {
155 get { return ViewState.GetString ("ErrorMessage", String.Empty); }
156 set { ViewState ["ErrorMessage"] = value; }
159 [DefaultValue(typeof (Color), "Red")]
160 public override Color ForeColor {
161 get { return forecolor; }
164 base.ForeColor = value;
173 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
174 [WebSysDescription ("")]
175 [WebCategory ("Misc")]
182 get { return valid; }
183 set { valid = value; }
186 protected bool PropertiesValid {
188 Control control = NamingContainer.FindControl (ControlToValidate);
196 protected bool RenderUplevel {
197 get { return render_uplevel; }
200 internal bool GetRenderUplevel ()
202 return render_uplevel;
206 // for 2.0: not XHTML attributes must be registered with RegisterExpandoAttribute
207 // when it will be implemented, in this case WebUIValidation_2.0.js muist be refactored
208 protected override void AddAttributesToRender (HtmlTextWriter writer)
210 /* if we're rendering uplevel, add our attributes */
211 if (render_uplevel) {
212 /* force an ID here if we weren't assigned one */
214 writer.AddAttribute(HtmlTextWriterAttribute.Id, ClientID);
216 if (ControlToValidate != String.Empty)
217 writer.AddAttribute ("controltovalidate", GetControlRenderID (ControlToValidate));
219 if (ErrorMessage != String.Empty)
220 writer.AddAttribute ("errormessage", ErrorMessage);
221 if (Text != String.Empty)
222 writer.AddAttribute ("text", Text);
224 if (ValidationGroup != String.Empty)
225 writer.AddAttribute ("validationgroup", ValidationGroup);
228 Page.ClientScript.RegisterExpandoAttribute (ClientID, "focusOnError", "t");
231 writer.AddAttribute ("enabled", "false");
234 if (Enabled && !IsValid) {
238 writer.AddAttribute ("isvalid", "false");
241 if (Display == ValidatorDisplay.Static)
242 writer.AddStyleAttribute ("visibility", "hidden");
244 writer.AddStyleAttribute ("display", "none");
247 if (Display != ValidatorDisplay.Static)
248 writer.AddAttribute ("display", Display.ToString());
251 base.AddAttributesToRender (writer);
254 protected void CheckControlValidationProperty (string name, string propertyName)
256 Control control = NamingContainer.FindControl (name);
257 PropertyDescriptor prop = null;
260 throw new HttpException (String.Format ("Unable to find control id '{0}'.", name));
262 prop = BaseValidator.GetValidationProperty (control);
264 throw new HttpException (String.Format ("Unable to find ValidationProperty attribute '{0}' on control '{1}'", propertyName, name));
267 protected virtual bool ControlPropertiesValid ()
269 if (ControlToValidate.Length == 0) {
270 throw new HttpException (String.Format ("ControlToValidate property of '{0}' cannot be blank.", ID));
273 CheckControlValidationProperty (ControlToValidate, "");
278 protected virtual bool DetermineRenderUplevel ()
280 if (!EnableClientScript)
283 if (HttpContext.Current == null)
287 /* From someplace on the web: "JavaScript 1.2
288 * and later (also known as ECMAScript) has
289 * built-in support for regular
291 ((Page.Request.Browser.EcmaScriptVersion.Major == 1
292 && Page.Request.Browser.EcmaScriptVersion.Minor >= 2)
293 || (Page.Request.Browser.EcmaScriptVersion.Major > 1))
295 /* document.getElementById, .getAttribute,
296 * etc, are all DOM level 1. I don't think we
297 * use anything in level 2.. */
298 && Page.Request.Browser.W3CDomVersion.Major >= 1);
300 return UplevelHelper.IsUplevel (
301 System.Web.Configuration.HttpCapabilitiesBase.GetUserAgentForDetection (HttpContext.Current.Request));
305 protected abstract bool EvaluateIsValid ();
307 protected string GetControlRenderID (string name)
309 Control control = NamingContainer.FindControl (name);
313 return control.ClientID;
316 protected string GetControlValidationValue (string name)
318 Control control = NamingContainer.FindControl (name);
323 PropertyDescriptor prop = BaseValidator.GetValidationProperty (control);
327 object o = prop.GetValue (control);
333 return ((ListItem) o).Value;
335 return o.ToString ();
338 public static PropertyDescriptor GetValidationProperty (object o)
340 PropertyDescriptorCollection props;
341 System.ComponentModel.AttributeCollection col;
343 props = TypeDescriptor.GetProperties (o);
344 col = TypeDescriptor.GetAttributes (o);
346 foreach (Attribute at in col) {
347 ValidationPropertyAttribute vpa = at as ValidationPropertyAttribute;
348 if (vpa != null && vpa.Name != null)
349 return props[vpa.Name];
360 override void OnInit (EventArgs e)
362 /* according to an msdn article, this is done here */
364 Page.Validators.Add (this);
367 Page.GetValidators (ValidationGroup).Add (this);
373 bool pre_render_called = false;
380 override void OnPreRender (EventArgs e)
382 base.OnPreRender (e);
384 pre_render_called = true;
386 ControlPropertiesValid ();
388 render_uplevel = DetermineRenderUplevel ();
389 if (render_uplevel) {
390 RegisterValidatorCommonScript ();
399 override void OnUnload (EventArgs e)
401 /* according to an msdn article, this is done here */
403 Page.Validators.Remove (this);
406 if (ValidationGroup != "")
407 Page.GetValidators (ValidationGroup).Remove (this);
414 protected void RegisterValidatorCommonScript ()
416 if (!Page.ClientScript.IsClientScriptIncludeRegistered (typeof (BaseValidator), "Mono-System.Web-ValidationClientScriptBlock"))
418 Page.ClientScript.RegisterClientScriptInclude (typeof (BaseValidator), "Mono-System.Web-ValidationClientScriptBlock",
419 Page.ClientScript.GetWebResourceUrl (typeof (BaseValidator),
421 "WebUIValidation_2.0.js"));
422 string webForm = (Page.IsMultiForm ? Page.theForm : "window");
423 Page.ClientScript.RegisterClientScriptBlock (typeof (BaseValidator), "Mono-System.Web-ValidationClientScriptBlock.Initialize", "WebFormValidation_Initialize(" + webForm + ");", true);
424 Page.ClientScript.RegisterOnSubmitStatement ("Mono-System.Web-ValidationOnSubmitStatement", "if (!" + webForm + ".ValidatorOnSubmit()) return false;");
425 Page.ClientScript.RegisterStartupScript (typeof (BaseValidator), "Mono-System.Web-ValidationStartupScript",
427 " + webForm + @".Page_ValidationActive = false;
428 " + webForm + @".ValidatorOnLoad();
429 " + webForm + @".ValidatorOnSubmit = function () {
430 if (this.Page_ValidationActive) {
431 return this.ValidatorCommonOnSubmit();
437 "WebUIValidation.js"));
439 Page.ClientScript.RegisterOnSubmitStatement ("Mono-System.Web-ValidationOnSubmitStatement",
440 "if (!ValidatorOnSubmit()) return false;");
441 Page.ClientScript.RegisterStartupScript ("Mono-System.Web-ValidationStartupScript",
442 "<script language=\"JavaScript\">\n" +
444 "var Page_ValidationActive = false;\n" +
445 "ValidatorOnLoad();\n" +
447 "function ValidatorOnSubmit() {\n" +
448 " if (Page_ValidationActive) {\n" +
449 " if (!ValidatorCommonOnSubmit())\n" +
450 " return Page_ClientValidate ();\n" +
460 protected virtual void RegisterValidatorDeclaration ()
462 Page.ClientScript.RegisterArrayDeclaration ("Page_Validators",
463 String.Format ("document.getElementById ('{0}')", ClientID));
471 override void Render (HtmlTextWriter writer)
474 if (!Enabled && !EnableClientScript)
477 if (render_uplevel) {
478 /* according to an msdn article, this is done here */
479 RegisterValidatorDeclaration ();
482 bool render_tags = false;
483 bool render_text = false;
484 bool render_nbsp = false;
487 if (!pre_render_called) {
491 else if (render_uplevel) {
494 render_text = Display != ValidatorDisplay.None;
496 if (Display != ValidatorDisplay.None)
497 render_text = !v || Display == ValidatorDisplay.Dynamic;
501 if (Display == ValidatorDisplay.Static) {
509 AddAttributesToRender (writer);
510 writer.RenderBeginTag (HtmlTextWriterTag.Span);
513 if (render_text || render_nbsp) {
528 writer.RenderEndTag ();
532 /* the docs say "public sealed" here */
540 if (Enabled && Visible)
541 IsValid = ControlPropertiesValid () && EvaluateIsValid ();