Control.Validating イベントとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

Control.Validating イベント

コントロールが検証を行っているときに発生します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Event Validating As
 CancelEventHandler

Visual Basic (使用法)

Dim instance As Control
Dim handler As CancelEventHandler

AddHandler instance.Validating, handler

public event CancelEventHandler Validating

C++

public:
event CancelEventHandler^ Validating {
    void add (CancelEventHandler^ value);
    void remove (CancelEventHandler^ value);
}

/** @event */
public void add_Validating (CancelEventHandler
 value)

/** @event */
public void remove_Validating (CancelEventHandler
 value)

JScript

JScript では、イベントは使用できますが、新規に宣言することはできません。

解説

キーボード (Tab、Shift + Tab など) を使用するか、Select メソッドまたは SelectNextControl メソッドを呼び出すか、ContainerControl.ActiveControl プロパティを現在のフォームに設定してフォーカスを変更するとき、次の順序でフォーカスイベントが発生します。

Enter
GotFocus
Leave
Validating
Validated
LostFocus

マウスを使用するか Focus メソッドを呼び出してフォーカスを変更するとき、フォーカスイベントは次の順序で発生します。

Enter
GotFocus
LostFocus
Leave
Validating
Validated

CausesValidation プロパティが false に設定されている場合、Validating イベントおよび Validated イベントは発生しません。

Validating イベントデリゲートで CancelEventArgs の Cancel プロパティが true に設定されると、通常は Validating イベントの後に発生するすべてのイベントが発生しなくなります。

イベント処理の詳細については、「イベントの利用」を参照してください。

使用例

派生クラス TextBox を使用して、ユーザーが入力した電子メールアドレスを検証するコード例を次に示します。電子メールアドレスが標準の書式 ("@" および "." を含む) ではない場合、検証は失敗し、ErrorProvider アイコンが表示され、イベントはキャンセルされます。この例では、TextBox および ErrorProvider コントロールがフォーム上で作成されていることが必要です。

Visual Basic

   Private Function ValidEmailAddress(ByVal
 emailAddress As String, ByRef
 errorMessage As String) As Boolean
      ' Confirm there is text in the control.
      If textBox1.Text.Length = 0 Then
         errorMessage = "E-mail address is required."
         Return False

      End If

      ' Confirm that there is an "@" and a "." in
 the e-mail address, and in the correct order.
      If emailAddress.IndexOf("@")
 > -1 Then
         If (emailAddress.IndexOf(".",
 emailAddress.IndexOf("@")) > emailAddress.IndexOf("@"))
 Then
            errorMessage = ""
            Return True
         End If
      End If

      errorMessage = "E-mail address must be valid e-mail address
 format." + ControlChars.Cr + _
        "For example 'someone@example.com' "
      Return False
End Function

   Private Sub textBox1_Validating(ByVal
 sender As Object, _
   ByVal e As System.ComponentModel.CancelEventArgs)
 Handles textBox1.Validating

      Dim errorMsg As String
      If Not ValidEmailAddress(textBox1.Text,
 errorMsg) Then
         ' Cancel the event and select the text to be corrected by the
 user.
         e.Cancel = True
         textBox1.Select(0, textBox1.Text.Length)

         ' Set the ErrorProvider error with the text to display. 
         Me.errorProvider1.SetError(textBox1, errorMsg)
      End If
   End Sub


   Private Sub textBox1_Validated(ByVal
 sender As Object, _
   ByVal e As System.EventArgs) Handles
 textBox1.Validated
      ' If all conditions have been met, clear the error provider of
 errors.
      errorProvider1.SetError(textBox1, "")
   End Sub

private void textBox1_Validating(object sender,
 
                 System.ComponentModel.CancelEventArgs e)
{
   string errorMsg;
   if(!ValidEmailAddress(textBox1.Text, out errorMsg))
   {
      // Cancel the event and select the text to be corrected by the
 user.
      e.Cancel = true;
      textBox1.Select(0, textBox1.Text.Length);

      // Set the ErrorProvider error with the text to display. 
      this.errorProvider1.SetError(textBox1, errorMsg);
   }
}

private void textBox1_Validated(object sender,
 System.EventArgs e)
{
   // If all conditions have been met, clear the ErrorProvider of errors.
   errorProvider1.SetError(textBox1, "");
}
public bool ValidEmailAddress(string
 emailAddress, out string errorMessage)
{
   // Confirm that the e-mail address string is not empty.
   if(emailAddress.Length == 0)
   {
      errorMessage = "e-mail address is required.";
         return false;
   }

   // Confirm that there is an "@" and a "." in
 the e-mail address, and in the correct order.
   if(emailAddress.IndexOf("@") > -1)
   {
      if(emailAddress.IndexOf(".", emailAddress.IndexOf("@")
 ) > emailAddress.IndexOf("@") )
      {
         errorMessage = "";
         return true;
      }
   }
   
   errorMessage = "e-mail address must be valid e-mail address format.\n"
 +
      "For example 'someone@example.com' ";
      return false;
}

C++

private:
   void textBox1_Validating( Object^ sender, System::ComponentModel::CancelEventArgs^
 e )
   {
      String^ errorMsg;
      if ( !ValidEmailAddress( textBox1->Text, &errorMsg
 ) )
      {
         // Cancel the event and select the text to be corrected by the
 user.
         e->Cancel = true;
         textBox1->Select( 0, textBox1->Text->Length );
         
         // Set the ErrorProvider error with the text to display.
         this->errorProvider1->SetError( textBox1, errorMsg
 );
      }
   }

   void textBox1_Validated( Object^ sender, System::EventArgs^
 e )
   {
      // If all conditions have been met, clear the ErrorProvider of
 errors.
      errorProvider1->SetError( textBox1, "" );
   }

public:
   bool ValidEmailAddress( String^ emailAddress, [Out]interior_ptr<String^>
 errorMessage )
   {
      // Confirm that the e-mail address String* is not empty.
      if ( emailAddress->Length == 0 )
      {
         *errorMessage = "e-mail address is required.";
         return false;
      }

      // Confirm that there is an "@" and a "." in
 the e-mail address, and in the correct order.
      if ( emailAddress->IndexOf( "@" ) > -1 )
      {
         if ( emailAddress->IndexOf( ".", emailAddress->IndexOf(
 "@" ) ) > emailAddress->IndexOf( "@" ) )
         {
            *errorMessage = "";
            return true;
         }
      }

      *errorMessage = "e-mail address must be valid e-mail address format.\n"
 +
         "For example 'someone@example.com' ";
      return false;
   }

private void textBox1_Validating(Object sender,
 
    System.ComponentModel.CancelEventArgs e)
{
    String errorMsg = "";

    if (!(ValidEmailAddress(textBox1.get_Text(), errorMsg))) {
        // Cancel the event and select the text to be corrected by the
 user.
        e.set_Cancel(true);
        textBox1.Select(0, textBox1.get_Text().get_Length());

        // Set the ErrorProvider error with the text to display. 
        this.errorProvider1.SetError(textBox1, errorMsg);
    }
} //textBox1_Validating

private void textBox1_Validated(Object sender,
 System.EventArgs e)
{
    // If all conditions have been met, clear the ErrorProvider of errors.
    errorProvider1.SetError(textBox1, "");
} //textBox1_Validated

public boolean ValidEmailAddress(String emailAddress, 
    /** @ref 
     */ String errorMessage)
{
    // Confirm that the e-mail address string is not empty.
    if (emailAddress.get_Length() == 0) {
        errorMessage = "e-mail address is required.";
        return false;
    }

    // Confirm that there is an "@" and a "." in
 the e-mail address, 
    // and in the correct order.
    if (emailAddress.IndexOf("@") > -1) {
        if (emailAddress.IndexOf(".", 
            emailAddress.IndexOf("@")) > emailAddress.IndexOf("@"))
 {
            errorMessage = "";
            return true;
        }
    }
    errorMessage = "e-mail address must be valid e-mail address format.\n"
 
        + "For example 'someone@example.com' ";
    return false;
} //ValidEmailAddress