BaseValidator.ControlToValidate Property (System.Web.UI.WebControls)

Switch View

ControlToValidate Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2005/.NET Framework 2.0

Other versions are also available for the following:

.NET Framework Class Library

BaseValidator.ControlToValidate Property

Gets or sets the input control to validate.

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in system.web.dll)

Syntax

Visual Basic (Declaration)

<ThemeableAttribute(False)> _
Public Property ControlToValidate As String

Visual Basic (Usage)

Dim instance As BaseValidator
Dim value As String

value = instance.ControlToValidate

instance.ControlToValidate = value

[ThemeableAttribute(false)] 
public string ControlToValidate { get; set; }

C++

[ThemeableAttribute(false)] 
public:
property String^ ControlToValidate {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_ControlToValidate ()

/** @property */
public void set_ControlToValidate (String value)

JScript

public function get ControlToValidate () : String

public function set ControlToValidate (value : String)

Property Value

The input control to validate. The default value is String.Empty, which indicates that this property is not set.

Remarks

Use the ControlToValidate property to specify the input control to validate. This property must be set to the ID of an input control for all validation controls except the CustomValidator control, which can be left blank. If you do not specify a valid input control, an exception will be thrown when the page is rendered. The ID must refer to a control within the same container as the validation control. It must be in the same page or user control, or it must be in the same template of a templated control.

The standard controls that can be validated are:

Note
For an input control to be validated, the System.Web.UI.ValidationPropertyAttribute attribute must be applied to the control.

All validation controls, except the RequiredFieldValidator control, will pass validation if the input control specified by the ControlToValidate property contains no text. If you are using a CustomValidator control, the client-side and server-side validation functions are not called either.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins Overview.

Topic	Location
Walkthrough: Validating User Input in a Web Forms Page	Building ASP .NET Web Applications in Visual Studio
Walkthrough: Validating User Input in a Web Forms Page	Building Applications with Visual Web Developer
Walkthrough: Validating User Input in a Web Forms Page	Building ASP .NET Web Applications in Visual Studio

Example

The following code example demonstrates how to use the ControlToValidate property to specify the input control to validate.

Visual Basic

<%@ Page Language="VB" AutoEventWireup="False" %>

<script runat="server">
 
  Sub Button_Click(ByVal sender As Object, ByVal e As EventArgs) Handles SubmitButton.Click
 
    If Page.IsValid Then
    
      MessageLabel.Text = "Page submitted successfully."
    
    Else
    
      MessageLabel.Text = "There is an error on the page."
    
    End If
    
  End Sub
 
</script>

<html>
  <body>
    <form runat="server">

      <h3>Validator Example</h3>
     
      Enter a number from 1 to 10.
      <asp:textbox id="NumberTextBox" 
        runat="server"/>

      <asp:rangevalidator id="NumberCompareValidator" 
        controltovalidate="NumberTextBox"
        enableclientscript="False"  
        type="Integer"
        display="Dynamic" 
        errormessage="Please enter a value from 1 to 10."
        maximumvalue="10"
        minimumvalue="1"  
        text="*"
        runat="server"/>

      <asp:requiredfieldvalidator id="TextBoxRequiredValidator" 
        controltovalidate="NumberTextBox"
        enableclientscript="False"
        display="Dynamic" 
        errormessage="Please enter a value."
        text="*"
        runat="server"/>

      <br><br>

      <asp:button id="SubmitButton"
        text="Submit"
        runat="server"/>
 
      <br><br>
       
      <asp:label id="MessageLabel" 
        runat="server"/>

      <br><br>

      <asp:validationsummary
        id="ErrorSummary"
        runat="server"/>
 
    </form>
  </body>
</html>

<%@ Page Language="C#" %>

<script runat="server">
 
  void Button_Click(Object sender, EventArgs e) 
  {
    if (Page.IsValid)
    {
      MessageLabel.Text = "Page submitted successfully.";
    }
    else
    {
      MessageLabel.Text = "There is an error on the page.";
    }
  }
 
</script>

<html>
  <body>
    <form runat="server">

      <h3>Validator Example</h3>
     
      Enter a number from 1 to 10.
      <asp:textbox id="NumberTextBox" 
        runat="server"/>

      <asp:rangevalidator id="NumberCompareValidator" 
        controltovalidate="NumberTextBox"
        enableclientscript="False"  
        type="Integer"
        display="Dynamic" 
        errormessage="Please enter a value from 1 to 10."
        maximumvalue="10"
        minimumvalue="1"  
        text="*"
        runat="server"/>

      <asp:requiredfieldvalidator id="TextBoxRequiredValidator" 
        controltovalidate="NumberTextBox"
        enableclientscript="False"
        display="Dynamic" 
        errormessage="Please enter a value."
        text="*"
        runat="server"/>

      <br><br>

      <asp:button id="SubmitButton"
        text="Submit"
        onclick="Button_Click"
        runat="server"/>
 
      <br><br>
       
      <asp:label id="MessageLabel" 
        runat="server"/>

      <br><br>

      <asp:validationsummary
        id="ErrorSummary"
        runat="server"/>
 
    </form>
  </body>
</html>

JScript

<%@ Page Language="JScript" %>

<script runat="server">
 
  function Button_Click(sender, e : EventArgs) 
  {
    if (Page.IsValid)
    {
      MessageLabel.Text = "Page submitted successfully.";
    }
    else
    {
      MessageLabel.Text = "There is an error on the page.";
    }
  }
 
</script>

<html>
  <body>
    <form runat="server">

      <h3>Validator Example</h3>
     
      Enter a number from 1 to 10.
      <asp:textbox id="NumberTextBox" 
        runat="server"/>

      <asp:rangevalidator id="NumberCompareValidator" 
        controltovalidate="NumberTextBox"
        enableclientscript="False"  
        type="Integer"
        display="Dynamic" 
        errormessage="Please enter a value from 1 to 10."
        maximumvalue="10"
        minimumvalue="1"  
        text="*"
        runat="server"/>

      <asp:requiredfieldvalidator id="TextBoxRequiredValidator" 
        controltovalidate="NumberTextBox"
        enableclientscript="False"
        display="Dynamic" 
        errormessage="Please enter a value."
        text="*"
        runat="server"/>

      <br><br>

      <asp:button id="SubmitButton"
        text="Submit"
        onclick="Button_Click"
        runat="server"/>
 
      <br><br>
       
      <asp:label id="MessageLabel" 
        runat="server"/>

      <br><br>

      <asp:validationsummary
        id="ErrorSummary"
        runat="server"/>
 
    </form>
  </body>
</html>

Platforms

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Version Information

.NET Framework

Supported in: 2.0, 1.1, 1.0

Reference

BaseValidator Class
BaseValidator Members
System.Web.UI.WebControls Namespace
String.Empty
System.Web.UI.ValidationPropertyAttribute
RequiredFieldValidator
CustomValidator