CustomValidator コントロール (全般リファレンス)

2008-08-16

更新 : 2007 年 11 月

入力コントロール内の値を評価し、カスタマイズされた検証ロジックを通過するかどうかを確認します。

<asp:CustomValidator
    AccessKey="string"
    BackColor="color name|#dddddd"
    BorderColor="color name|#dddddd"
    BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|Groove|Ridge|
        Inset|Outset"
    BorderWidth="size"
    ClientValidationFunction="string"
    ControlToValidate="string"
    CssClass="string"
    Display="None|Static|Dynamic"
    EnableClientScript="True|False"
    Enabled="True|False"
    EnableTheming="True|False"
    EnableViewState="True|False"
    ErrorMessage="string"
    Font-Bold="True|False"
    Font-Italic="True|False"
    Font-Names="string"
    Font-Overline="True|False"
    Font-Size="string|Smaller|Larger|XX-Small|X-Small|Small|Medium|
        Large|X-Large|XX-Large"
    Font-Strikeout="True|False"
    Font-Underline="True|False"
    ForeColor="color name|#dddddd"
    Height="size"
    ID="string"
    OnDataBinding="DataBinding event handler"
    OnDisposed="Disposed event handler"
    OnInit="Init event handler"
    OnLoad="Load event handler"
    OnPreRender="PreRender event handler"
    OnServerValidate="ServerValidate event handler"
    OnUnload="Unload event handler"
    runat="server"
    SetFocusOnError="True|False"
    SkinID="string"
    Style="string"
    TabIndex="integer"
    Text="string"
    ToolTip="string"
    ValidateEmptyText="True|False"
    ValidationGroup="string"
    Visible="True|False"
    Width="size"
/>

解説

CustomValidator コントロールを使用して、カスタマイズされた検証ロジックを持つ検証コントロールを作成できます。たとえば、テキストボックスに入力された値が偶数かどうかを確認する検証コントロールを作成できます。

検証コントロールは、常にサーバー上で検証を行います。これらの検証コントロールは、DHTML をサポートするブラウザ (Microsoft Internet Explorer 4.0 以降など) がクライアント上で検証を実行できるようにするための、完全なクライアント側の実装も備えています。クライアント側で検証を行うと、ユーザーが入力したデータをサーバーに送信する前にチェックできるため、検証プロセスが強化されます。これにより、フォームが送信される前にクライアント側でエラーを検出できるため、サーバー側での検証で必要となる情報のラウンドトリップが不要になります。

サーバー側の検証関数を作成するには、検証を実行する ServerValidate イベントのハンドラを作成します。検証する入力コントロールの文字列は、イベントハンドラにパラメータとして渡される ServerValidateEventArgs オブジェクトの Value プロパティを使用してアクセスできます。検証の結果は ServerValidateEventArgs オブジェクトの IsValid プロパティに格納されます。

クライアント側の検証関数を作成するには、まず、上の手順に従ってサーバー側の検証関数を追加します。次に、クライアント側の検証スクリプト関数を .aspx ページに追加します。

Visual Basic を使用している場合は、次の形式で関数を記述する必要があります。

Sub ValidationFunctionName (source, arguments)

JScript を使用している場合は、次の形式で関数を記述する必要があります。

Function ValidationFunctionName (source, arguments)

ClientValidationFunction プロパティを使用して、CustomValidator コントロールに関連付けられたクライアント側の検証スクリプト関数の名前を指定します。スクリプト関数はクライアント側で実行されるため、対象とするブラウザがサポートしている Visual Basic や JScript などの言語で作成する必要があります。

サーバー側の検証と同様に、検証対象の値にアクセスするには、arguments パラメータの Value プロパティを使用します。検証の結果を返すには、arguments パラメータの IsValid プロパティを設定します。

セキュリティに関するメモ :
クライアント側の検証関数を作成する場合は、サーバー側の検証関数の機能を必ず作成してください。対応するサーバー側の関数がないクライアント側の検証関数を作成した場合は、悪意のあるコードが検証を省略できてしまう可能性が生まれます。

複数の検証コントロールを同じ入力コントロールに関連付け、その入力コントロールに対して異なる基準で検証を実行できます。たとえば、買い物カゴに追加する商品の数量をユーザーが入力できるようになっている TextBox コントロールに、複数の検証コントロールを適用できます。CustomValidator コントロールを使用して、指定された値が在庫数を上回っていないことを確認し、RequiredFieldValidator コントロールを使用して、ユーザーが TextBox コントロールに値を入力したかどうかを確認できます。

メモ :
入力コントロールが空の場合、検証関数は呼び出されず、そのまま検証が成功します。ユーザーが入力コントロールへの入力を省略しないようにする場合は、RequiredFieldValidator コントロールを使用します。

CustomValidator コントロールは、ControlToValidate プロパティを設定しなくても使用できます。通常、この方法は、複数の入力コントロールを検証する場合や、検証コントロールとは併用できない入力コントロール (CheckBox コントロールなど) を検証する場合に使用されます。この場合、ServerValidate イベントのイベントハンドラやクライアント側の検証関数に渡される arguments パラメータの Value プロパティに、必ず空の文字列 ("") が含まれます。ただし、これらの検証関数は依然として、サーバーとクライアントの両方で検証を行うために適切な場所で呼び出されます。検証対象の値にアクセスするには、検証対象の入力コントロールをプログラムによって参照し、適切なプロパティの値を取得する必要があります。たとえば、CheckBox コントロールをサーバー上で検証するには、検証コントロールの ControlToValidate プロパティは設定せずに、ServerValidate イベントのハンドラとして次のコードを使用します。

Sub ServerValidation (source As object, args As ServerValidateEventArgs)
 
   args.IsValid = (CheckBox1.Checked = True)

End Sub

void ServerValidation (object source, ServerValidateEventArgs args)
{
      
   args.IsValid = (CheckBox1.Checked == true);
   
}

CustomValidator コントロールの詳細については、System.Web.UI.WebControls.CustomValidator クラスを参照してください。

例

テキストボックスに入力された値が偶数かどうかをサーバー上で検証する CustomValidator コントロールの作成方法を次の例に示します。検証後に、その結果がページに表示されます。

セキュリティに関するメモ :
このコード例には、ユーザー入力を受け付けるテキストボックスがあるため、セキュリティ上の脅威になる可能性があります。既定では、ASP.NET Web ページは、ユーザー入力にスクリプトまたは HTML 要素が含まれていないことを検証します。詳細については、「スクリプトによる攻略の概要」を参照してください。

このコード例には、ユーザー入力を受け付けるテキストボックスがあるため、セキュリティ上の脅威になる可能性があります。既定では、ASP.NET Web ページは、ユーザー入力にスクリプトまたは HTML 要素が含まれていないことを検証します。詳細については、「スクリプトによる攻略の概要」を参照してください。

<%@ Page Language="VB" AutoEventWireup="True" %>
<html>
<head>
   <script runat="server">
      Sub ValidateBtn_OnClick(sender As object, e As EventArgs) 
         If Page.IsValid Then 
            lblOutput.Text = "Page is valid."
         Else 
            lblOutput.Text = "Page is not valid!"
         End If
      End Sub
      Sub ServerValidation (source As object, arguments As ServerValidateEventArgs)

         Dim num As Integer = Integer.Parse(arguments.Value)
         arguments.IsValid = ((num mod 2) = 0)
         
      End Sub
   </script>    
</head>
<body>
   <form runat="server">
      <h3>CustomValidator Example</h3>
      <asp:Label id=lblOutput runat="server" 
           Text="Enter an even number:" 
           Font-Name="Verdana" 
           Font-Size="10pt" /><br>
      <p />
      <asp:TextBox id="Text1" 
           runat="server" />
      &nbsp;&nbsp;
      <asp:CustomValidator id="CustomValidator1"
           ControlToValidate="Text1"
           OnServerValidate="ServerValidation"
           Display="Static"
           ErrorMessage="Not an even number!"
           ForeColor="green"
           Font-Name="verdana" 
           Font-Size="10pt"
           runat="server"/>
      <p />
      <asp:Button id="Button1"
           Text="Validate" 
           OnClick="ValidateBtn_OnClick" 
           runat="server"/>
   </form>
</body>
</html>

<%@ Page Language="C#" AutoEventWireup="True" %>
<html>
<head>
   <script runat="server">
      void ValidateBtn_OnClick(object sender, EventArgs e) 
      { 
         if (Page.IsValid) 
         {
            lblOutput.Text = "Page is valid.";
         }
         else 
         {
            lblOutput.Text = "Page is not valid!";
         }
      }
      void ServerValidation (object source, ServerValidateEventArgs arguments)
      {

         int i = int.Parse(arguments.Value);
         arguments.IsValid = ((i%2) == 0);

      }
   </script>    
</head>
<body>
   <form runat="server">
      <h3>CustomValidator Example</h3>
      <asp:Label id=lblOutput runat="server" 
           Text="Enter an even number:" 
           Font-Name="Verdana" 
           Font-Size="10pt" /><br>
      <p />
      <asp:TextBox id="Text1" 
           runat="server" />
      &nbsp;&nbsp;
      <asp:CustomValidator id="CustomValidator1"
           ControlToValidate="Text1"
           OnServerValidate="ServerValidation"
           Display="Static"
           ErrorMessage="Not an even number!"
           ForeColor="green"
           Font-Name="verdana" 
           Font-Size="10pt"
           runat="server"/>
      <p />
      <asp:Button id="Button1"
           Text="Validate" 
           OnClick="ValidateBtn_OnClick" 
           runat="server"/>
   </form>
</body>
</html>

次の例は、前の例と同じ検証ルーチンをクライアント側で実行する CustomValidator コントロールの作成方法を示しています。

<%@ Page Language="VB" AutoEventWireup="True" %>
<html>
<head>
   <script runat="server">
      Sub ValidateBtn_OnClick(sender As object, e As EventArgs) 
         If Page.IsValid Then 
            lblOutput.Text = "Page is valid."
         Else 
            lblOutput.Text = "Page is not valid!"
         End If
      End Sub
      Sub ServerValidation (source As object, arguments As ServerValidateEventArgs)

         Dim num As Integer = Integer.Parse(arguments.Value)
         arguments.IsValid = ((num mod 2) = 0)
 
      End Sub
   </script>    
</head>
<body>
   <form runat="server">
      <h3>CustomValidator Example</h3>
      <asp:Label id=lblOutput runat="server" 
           Text="Enter an even number:" 
           Font-Name="Verdana" 
           Font-Size="10pt" /><br>
      <p />
      <asp:TextBox id="Text1" 
           runat="server" />
      &nbsp;&nbsp;
      <asp:CustomValidator id="CustomValidator1"
           ControlToValidate="Text1"
           ClientValidationFunction="ClientValidate"
           OnServerValidate="ServerValidation"
           Display="Static"
           ErrorMessage="Not an even number!"
           ForeColor="green"
           Font-Name="verdana" 
           Font-Size="10pt"
           runat="server"/>
      <p />
      <asp:Button id="Button1"
           Text="Validate" 
           OnClick="ValidateBtn_OnClick" 
           runat="server"/>
   </form>
</body>
</html>
<script language="javascript">
   <!--
   function ClientValidate(source, arguments)
   {
      if ((arguments.Value % 2) == 0)
         arguments.IsValid=true;
      else
         arguments.IsValid=false;
   }
   // -->
</script>

<%@ Page Language="C#" AutoEventWireup="True" %>
<html>
<head>
   <script runat="server">
      void ValidateBtn_OnClick(object sender, EventArgs e) 
      { 
         if (Page.IsValid) 
         {
            lblOutput.Text = "Page is valid.";
         }
         else 
         {
            lblOutput.Text = "Page is not valid!";
         }
      }
      void ServerValidation (object source, ServerValidateEventArgs arguments)
      {
         
            int i = int.Parse(arguments.Value);
            arguments.IsValid = ((i%2) == 0);

      }
   </script>    
</head>
<body>
   <form runat="server">
      <h3>CustomValidator Example</h3>
      <asp:Label id=lblOutput runat="server" 
           Text="Enter an even number:" 
           Font-Name="Verdana" 
           Font-Size="10pt" /><br>
      <p />
      <asp:TextBox id="Text1" 
           runat="server" />
      &nbsp;&nbsp;
      <asp:CustomValidator id="CustomValidator1"
           ControlToValidate="Text1"
           ClientValidationFunction="ClientValidate"
           OnServerValidate="ServerValidation"
           Display="Static"
           ErrorMessage="Not an even number!"
           ForeColor="green"
           Font-Name="verdana" 
           Font-Size="10pt"
           runat="server"/>
      <p />
      <asp:Button id="Button1"
           Text="Validate" 
           OnClick="ValidateBtn_OnClick" 
           runat="server"/>
   </form>
</body>
</html>
<script language="javascript">
   <!--
   function ClientValidate(source, arguments)
   {
      if ((arguments.Value % 2) == 0)
         arguments.IsValid=true;
      else
         arguments.IsValid=false;
   }
   // -->
</script>

参照

CustomValidator

その他の技術情報

検証サーバーコントロール構文

次の方法で共有

CustomValidator コントロール (全般リファレンス)

解説

例

参照

参照

その他の技術情報

その他のリソース