ValidatePasswordEventArgs.Cancel プロパティ

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

ValidatePasswordEventArgs.Cancel プロパティ

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

現在のユーザー作成、パスワード変更、またはパスワード リセットの各アクションをキャンセルするかどうかを示す値を取得または設定します。

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

Visual Basic (宣言)

Public Property Cancel As
 Boolean

Visual Basic (使用法)

Dim instance As ValidatePasswordEventArgs
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。既定値は false です。

解説

Cancel プロパティは、現在の CreateUser、ChangePassword、または ResetPassword の各アクションをキャンセルする目的で使用されます。ValidatingPassword イベントで Cancel プロパティを true に設定することにより、現在のアクションをキャンセルできます。

Cancel プロパティを true に設定して現在のアクションをキャンセルする場合、FailureInformation プロパティに、パスワード検証エラーの原因を説明する例外を設定できます。呼び出し元のメソッドは、FailureInformation プロパティに設定された例外をスローします。FailureInformation プロパティが null 参照 (Visual Basic では Nothing) である場合、呼び出し元は汎用パスワード検証エラー例外をスローします。

使用例

次のコード例に、ユーザーが入力したパスワードの形式を検証し、必要な形式と一致しない場合は処理をキャンセルする ValidatingPassword イベントを示します。

Visual Basic

Public Sub Page_Load()
    AddHandler Membership.ValidatingPassword, _
    New MembershipValidatePasswordEventHandler(AddressOf
 OnValidatePassword)
End Sub

Public Sub OnValidatePassword(sender As
 Object, _
                               args As ValidatePasswordEventArgs)
  Dim r As System.Text.RegularExpressions.Regex
 =  _
    New System.Text.RegularExpressions.Regex("(?=.{6
,})(?=(.*\d){1,})(?=(.*\W){1,})")
         

  If Not r.IsMatch(args.Password) Then
    args.FailureInformation = _
      New HttpException("Password must be at
 least 6 characters long and " & _
                        "contain at least one number and one special
 character.")
    args.Cancel = True
  End If
End Sub

C#

public void Page_Load()
{
  Membership.ValidatingPassword +=
    new MembershipValidatePasswordEventHandler(OnValidatePassword);
}

public void OnValidatePassword(object sender
,
                              ValidatePasswordEventArgs args)
{
  System.Text.RegularExpressions.Regex r =
    new System.Text.RegularExpressions.Regex(@"(?=.{6,})(?=(.*\d){1
,})(?=(.*\W){1,})");


  if (!r.IsMatch(args.Password))
  {
    args.FailureInformation =
      new HttpException("Password must be at least 6 characters
 long and " +
                        "contain at least one number and one special character.");
    args.Cancel = true;
  }
}

プラットフォーム

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

参照

関連項目
ValidatePasswordEventArgs クラス
ValidatePasswordEventArgs メンバ
System.Web.Security 名前空間
その他の技術情報
メンバシップの概要