LoginCancelEventArgsとは何？わかりやすく解説 Weblio辞書

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

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

LoginCancelEventArgs クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

キャンセルできるイベントのデータを提供します。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Class LoginCancelEventArgs
    Inherits EventArgs

Visual Basic (使用法)

Dim instance As LoginCancelEventArgs

public class LoginCancelEventArgs : EventArgs

C++

public ref class LoginCancelEventArgs : public
 EventArgs

public class LoginCancelEventArgs extends EventArgs

JScript

public class LoginCancelEventArgs extends
 EventArgs

解説

キャンセルできるイベントは、Web サイトへのログオンなど、キャンセル可能なアクションをコンポーネントが実行しようとしたときに発生します。

LoginCancelEventArgs クラスには、イベントをキャンセルするかどうかを示す Cancel プロパティがあります。LoginCancelEventArgs オブジェクトは、Login、CreateUserWizard、PasswordRecovery の各コントロールなどの、キャンセルできるアクションのあるコントロールで使用されます。

使用例

LoggingIn イベントを使用して、ユーザーが整形式の電子メールアドレスを UserName プロパティに入力したことを確認するコード例を次に示します。整形式の電子メールアドレスが入力されなかった場合は、LoggingIn イベントハンドラが LoginCancelEventArgs オブジェクトの Cancel プロパティを true に設定して、ログオン操作をキャンセルします。次に、InstructionText プロパティで指定されているエラーメッセージが表示されます。

Visual Basic

Partial Class LoginCancelEventArgsvb_aspx
    Inherits System.Web.UI.Page

    Function IsValidEmail(ByVal strIn As
 String) As Boolean
        ' Return true if strIn is in valid e-mail 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 e-mail
 address."
            e.Cancel = True
        Else
            Login1.InstructionText = String.Empty
        End If
    End Sub

End Class

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

    bool IsValidEmail(string strIn)
    {
        // Return true if strIn is in valid e-mail 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 e-mail address.";
            e.Cancel = true;
        }
        else
        {
            Login1.InstructionText = String.Empty;
        }
    }
}

前述の例を実行するために使用できる .aspx ファイルを次に示します。

Visual Basic

<%@ 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>
    <body>
        <form id="Form1" runat="server">
            <asp:Login id="Login1" 
              runat="server" 
              onloggingin="OnLoggingIn">
            </asp:Login>
        </form>
    </body>
</html>

<%@ 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>
    <body>
        <form id="Form1" runat="server">
            <asp:Login id="Login1" 
              runat="server" 
              onloggingin="OnLoggingIn">
            </asp:Login>
        </form>
    </body>
</html>

.NET Framework のセキュリティ

AspNetHostingPermission (ホスト環境での動作に必要なアクセス許可)要求値 : LinkDemand; アクセス許可値 : Minimal。
AspNetHostingPermission (ホスト環境での動作に必要なアクセス許可)要求値 : InheritanceDemand; アクセス許可値 : Minimal。

継承階層

System.Object
   System.EventArgs
    System.Web.UI.WebControls.LoginCancelEventArgs
       System.Web.UI.WebControls.MailMessageEventArgs

スレッドセーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッドセーフです。インスタンスメンバの場合は、スレッドセーフであるとは限りません。

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
LoginCancelEventArgs メンバ
System.Web.UI.WebControls 名前空間
Login クラス
CreateUserWizard クラス
PasswordRecovery
Login.LoggingIn イベント
その他の技術情報
ASP.NET ログインコントロール
ログインコントロールのセキュリティ保護

LoginCancelEventArgs コンストラクタ ()

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

Cancel プロパティを false に設定して、LoginCancelEventArgs クラスの新しいインスタンスを初期化します。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New LoginCancelEventArgs

public LoginCancelEventArgs ()

C++

public:
LoginCancelEventArgs ()

public LoginCancelEventArgs ()

JScript

public function LoginCancelEventArgs ()

プラットフォーム

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

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
LoginCancelEventArgs クラス
LoginCancelEventArgs メンバ
System.Web.UI.WebControls 名前空間
その他の技術情報
ASP.NET ログインコントロール

LoginCancelEventArgs コンストラクタ (Boolean)

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

Cancel プロパティを指定の値に設定して、LoginCancelEventArgs クラスの新しいインスタンスを初期化します。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    cancel As Boolean _
)

Visual Basic (使用法)

Dim cancel As Boolean

Dim instance As New LoginCancelEventArgs(cancel)

public LoginCancelEventArgs (
    bool cancel
)

C++

public:
LoginCancelEventArgs (
    bool cancel
)

public LoginCancelEventArgs (
    boolean cancel
)

JScript

public function LoginCancelEventArgs (
    cancel : boolean
)

パラメータ

cancel: イベントをキャンセルする場合は true。それ以外の場合は false。

プラットフォーム

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

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
LoginCancelEventArgs クラス
LoginCancelEventArgs メンバ
System.Web.UI.WebControls 名前空間
その他の技術情報
ASP.NET ログインコントロール

LoginCancelEventArgs コンストラクタ

LoginCancelEventArgs クラスの新しいインスタンスを初期化します。
オーバーロードの一覧

名前	説明
LoginCancelEventArgs ()	Cancel プロパティを false に設定して、LoginCancelEventArgs クラスの新しいインスタンスを初期化します。
LoginCancelEventArgs (Boolean)	Cancel プロパティを指定の値に設定して、LoginCancelEventArgs クラスの新しいインスタンスを初期化します。

参照

その他の技術情報

ASP.NET ログインコントロール

LoginCancelEventArgs プロパティ

パブリックプロパティパブリックプロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。

参照

その他の技術情報

ASP.NET ログインコントロール
ログインコントロールのセキュリティ保護

LoginCancelEventArgs メソッド

パブリックメソッドパブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

その他の技術情報

ASP.NET ログインコントロール
ログインコントロールのセキュリティ保護

LoginCancelEventArgs メンバ

キャンセルできるイベントのデータを提供します。

LoginCancelEventArgs データ型で公開されるメンバを以下の表に示します。

パブリックコンストラクタ

	名前	説明
	LoginCancelEventArgs	オーバーロードされます。 LoginCancelEventArgs クラスの新しいインスタンスを初期化します。

パブリックプロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。

パブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)