LoginCancelEventArgs.Cancel プロパティ

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

LoginCancelEventArgs.Cancel プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

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

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

Visual Basic (宣言)

Public Property Cancel As
 Boolean

Visual Basic (使用法)

Dim instance As LoginCancelEventArgs
Dim value As Boolean

value = instance.Cancel

instance.Cancel = value

C#

public bool Cancel { get;
 set; }

C++

public:
property bool Cancel {
    bool get ();
    void set (bool value);
}

J#

/** @property */
public boolean get_Cancel ()

/** @property */
public void set_Cancel (boolean value)

JScript

public function get Cancel
 () : boolean

public function set Cancel
 (value : boolean)

プロパティ値
イベントをキャンセルする場合は true。それ以外の場合は false。

解説

Cancel プロパティを使用して、LoggingIn、LoggingOut、ChangingPassword などのイベントをキャンセルする必要があるかどうかを示すことができます。

使用例

LoggingIn イベントを使用して、ユーザーが整形式の電子メール アドレスを UserName プロパティに入力したことを確認するコード例を次に示します。整形式の電子メール アドレスが入力されなかった場合は、LoggingIn イベント ハンドラが Cancel プロパティを true に設定し、エラー メッセージが表示されます。この例の実行に使用できる .aspx ファイルについては、LoginCancelEventArgs のトピックを参照してください。

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

C#

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;
        }
    }
}

プラットフォーム

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 クラス
LoginCancelEventArgs メンバ
System.Web.UI.WebControls 名前空間
Login クラス
Login.LoggingIn イベント
その他の技術情報
ASP.NET ログイン コントロール