LoginCancelEventArgs LoginCancelEventArgs LoginCancelEventArgs LoginCancelEventArgs Class

定義

キャンセルできるイベントのデータを提供します。Provides data for a cancelable event.

public ref class LoginCancelEventArgs : EventArgs
public class LoginCancelEventArgs : EventArgs
type LoginCancelEventArgs = class
    inherit EventArgs
Public Class LoginCancelEventArgs
Inherits EventArgs
継承
LoginCancelEventArgsLoginCancelEventArgsLoginCancelEventArgsLoginCancelEventArgs
派生

次のコード例では、LoggingInで適切な形式の電子メール アドレスをユーザーが入力したことを確認するイベント、UserNameプロパティ。The following code example uses the LoggingIn event to ensure that the user has entered a well-formed email address in the UserName property. ない場合、LoggingInイベント ハンドラーを設定してログオンの試行を取り消します、Cancelのプロパティ、LoginCancelEventArgsオブジェクトをtrueします。エラー メッセージがで指定し、InstructionTextプロパティが表示されます。If not, the LoggingIn event handler cancels the logon attempt by setting the Cancel property of the LoginCancelEventArgs object to true.Then the error message specified in the InstructionText property is displayed.

public partial class LoginCancelEventArgscs_aspx : System.Web.UI.Page
{

    bool IsValidEmail(string strIn)
    {
        // Return true if strIn is in valid email format.
        return System.Text.RegularExpressions.Regex.IsMatch(strIn, 
            @"^([\w-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([\w-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$");
    }
    
    protected void OnLoggingIn(object sender, System.Web.UI.WebControls.LoginCancelEventArgs e)
    {
        if (!IsValidEmail(Login1.UserName))
        {
            Login1.InstructionText = "You must enter a valid email address.";
            e.Cancel = true;
        }
        else
        {
            Login1.InstructionText = String.Empty;
        }
    }
}
Partial Class LoginCancelEventArgsvb_aspx
    Inherits System.Web.UI.Page

    Function IsValidEmail(ByVal strIn As String) As Boolean
        ' Return true if strIn is in valid email format.
        Return Regex.IsMatch(strIn, _
            ("^([\w-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([\w-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$"))
    End Function

    Protected Sub OnLoggingIn(ByVal sender As Object, ByVal e As System.Web.UI.WebControls.LoginCancelEventArgs)
        If Not IsValidEmail(Login1.UserName) Then
            Login1.InstructionText = "You must enter a valid email address."
            e.Cancel = True
        Else
            Login1.InstructionText = String.Empty
        End If
    End Sub

End Class

以下は、前の例を実行するために使用する .aspx ファイルです。The following is the .aspx file that can be used to run the preceding example.

<%@ Page Language="C#" CodeFile="LoginCancelEventArgs.cs" Inherits="LoginCancelEventArgscs_aspx" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
    <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
        <form id="Form1" runat="server">
            <asp:Login id="Login1" 
              runat="server" 
              onloggingin="OnLoggingIn">
            </asp:Login>
        </form>
    </body>
</html>
<%@ Page Language="VB" AutoEventWireup="false" CodeFile="LoginCancelEventArgs.vb" Inherits="LoginCancelEventArgsvb_aspx" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
    <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
        <form id="Form1" runat="server">
            <asp:Login id="Login1" 
              runat="server" 
              onloggingin="OnLoggingIn">
            </asp:Login>
        </form>
    </body>
</html>

注釈

コンポーネントは、Web サイトへのログオンなど、キャンセル可能なアクションを実行しようとしていますが、キャンセル可能なイベントが発生します。A cancelable event is raised when a component is about to perform an action that can be canceled, such as logging on to a Web site.

LoginCancelEventArgsクラスには、Cancelイベントを取り消す必要があるかどうかを示すプロパティです。The LoginCancelEventArgs class provides the Cancel property to indicate whether the event should be canceled. ALoginCancelEventArgsなど、キャンセル可能なアクションを持つコントロールにオブジェクトを使用、Loginコントロール、CreateUserWizardコントロール、およびPasswordRecoveryコントロール。A LoginCancelEventArgs object is used with controls that have cancelable actions, such as the Login control, the CreateUserWizard control, and the PasswordRecovery control.

コンストラクター

LoginCancelEventArgs() LoginCancelEventArgs() LoginCancelEventArgs() LoginCancelEventArgs()

LoginCancelEventArgs プロパティを false に設定して、Cancel クラスの新しいインスタンスを初期化します。Initializes a new instance of the LoginCancelEventArgs class with the Cancel property set to false.

LoginCancelEventArgs(Boolean) LoginCancelEventArgs(Boolean) LoginCancelEventArgs(Boolean) LoginCancelEventArgs(Boolean)

LoginCancelEventArgs プロパティを指定の値に設定して、Cancel クラスの新しいインスタンスを初期化します。Initializes a new instance of the LoginCancelEventArgs class with the Cancel property set to the specified value.

プロパティ

Cancel Cancel Cancel Cancel

イベントをキャンセルするかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the event should be canceled.

メソッド

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

適用対象

こちらもご覧ください