1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ValidatePasswordEventArgs" FullName="System.Web.Security.ValidatePasswordEventArgs">
<TypeSignature Language="C#" Value="public sealed class ValidatePasswordEventArgs : EventArgs" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.EventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="E:System.Web.Security.MembershipProvider.ValidatingPassword" /> event is raised when the <see cref="M:System.Web.Security.MembershipProvider.CreateUser(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Object,System.Web.Security.MembershipCreateStatus@)" />, <see cref="M:System.Web.Security.MembershipProvider.ChangePassword(System.String,System.String,System.String)" />, or <see cref="M:System.Web.Security.MembershipProvider.ResetPassword(System.String,System.String)" /> method of a membership provider is called.</para>
<para>You can handle the <see cref="E:System.Web.Security.MembershipProvider.ValidatingPassword" /> event to validate password formats and values for membership users.</para>
<para>You can cancel the current <see cref="M:System.Web.Security.MembershipProvider.CreateUser(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Object,System.Web.Security.MembershipCreateStatus@)" />, <see cref="M:System.Web.Security.MembershipProvider.ChangePassword(System.String,System.String,System.String)" />, or <see cref="M:System.Web.Security.MembershipProvider.ResetPassword(System.String,System.String)" /> action by setting the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.Cancel" /> property to true during the <see cref="E:System.Web.Security.MembershipProvider.ValidatingPassword" /> event.</para>
<para>If you cancel the current action by setting the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.Cancel" /> property to true, you can set the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.FailureInformation" /> property to an exception that describes the reason for the password-validation failure. The calling method will throw the exception that the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.FailureInformation" /> property is set to. If the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.FailureInformation" /> property is null, the caller will throw a generic password-validation failure exception.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides event data for the <see cref="E:System.Web.Security.MembershipProvider.ValidatingPassword" /> event of the <see cref="T:System.Web.Security.MembershipProvider" /> class.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ValidatePasswordEventArgs (string userName, string password, bool isNewUser);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="userName" Type="System.String" />
<Parameter Name="password" Type="System.String" />
<Parameter Name="isNewUser" Type="System.Boolean" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Security.ValidatePasswordEventArgs.#ctor(System.String,System.String,System.Boolean)" /> constructor is used by a membership provider implementation in the <see cref="M:System.Web.Security.MembershipProvider.CreateUser(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Object,System.Web.Security.MembershipCreateStatus@)" />, <see cref="M:System.Web.Security.MembershipProvider.ChangePassword(System.String,System.String,System.String)" />, and <see cref="M:System.Web.Security.MembershipProvider.ResetPassword(System.String,System.String)" /> method implementations.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a new instance of the <see cref="T:System.Web.Security.ValidatePasswordEventArgs" /> class.</para>
</summary>
<param name="userName">
<attribution license="cc4" from="Microsoft" modified="false" />The membership user name for the current create-user, change-password, or reset-password action.</param>
<param name="password">
<attribution license="cc4" from="Microsoft" modified="false" />The new password for the specified membership user.</param>
<param name="isNewUser">
<attribution license="cc4" from="Microsoft" modified="false" />true if the event is occurring while a new user is being created; otherwise, false.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Cancel">
<MemberSignature Language="C#" Value="public bool Cancel { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Security.ValidatePasswordEventArgs.Cancel" /> property is used to cancel the current <see cref="M:System.Web.Security.MembershipProvider.CreateUser(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Object,System.Web.Security.MembershipCreateStatus@)" />, <see cref="M:System.Web.Security.MembershipProvider.ChangePassword(System.String,System.String,System.String)" />, or <see cref="M:System.Web.Security.MembershipProvider.ResetPassword(System.String,System.String)" /> action. You can cancel the current action by setting the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.Cancel" /> property to true during the <see cref="E:System.Web.Security.MembershipProvider.ValidatingPassword" /> event.</para>
<para>If you cancel the current action by setting the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.Cancel" /> property to true, you can set the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.FailureInformation" /> property to an exception that describes the reason for the password-validation failure. The calling method will throw the exception that the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.FailureInformation" /> property is set to. If the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.FailureInformation" /> property is null, the caller will throw a generic password-validation failure exception.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value that indicates whether the current create-user, change-password, or reset-password action will be canceled.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="FailureInformation">
<MemberSignature Language="C#" Value="public Exception FailureInformation { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Exception</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Security.ValidatePasswordEventArgs.FailureInformation" /> property is used when the current <see cref="M:System.Web.Security.MembershipProvider.CreateUser(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Object,System.Web.Security.MembershipCreateStatus@)" />, <see cref="M:System.Web.Security.MembershipProvider.ChangePassword(System.String,System.String,System.String)" />, or <see cref="M:System.Web.Security.MembershipProvider.ResetPassword(System.String,System.String)" /> action has been canceled by setting the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.Cancel" /> property to true.</para>
<para>The <see cref="P:System.Web.Security.ValidatePasswordEventArgs.FailureInformation" /> property is set to an exception that describes the reason for the password-validation failure. The calling method will throw the exception that the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.FailureInformation" /> property is set to. If the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.FailureInformation" /> property is null, the caller will throw a generic password-validation failure exception.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets an exception that describes the reason for the password-validation failure.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IsNewUser">
<MemberSignature Language="C#" Value="public bool IsNewUser { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value that indicates whether the <see cref="E:System.Web.Security.MembershipProvider.ValidatingPassword" /> event is being raised during a call to the <see cref="M:System.Web.Security.MembershipProvider.CreateUser(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Object,System.Web.Security.MembershipCreateStatus@)" /> method.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Password">
<MemberSignature Language="C#" Value="public string Password { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="E:System.Web.Security.MembershipProvider.ValidatingPassword" /> event is raised when the <see cref="M:System.Web.Security.MembershipProvider.CreateUser(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Object,System.Web.Security.MembershipCreateStatus@)" />, <see cref="M:System.Web.Security.MembershipProvider.ChangePassword(System.String,System.String,System.String)" />, or <see cref="M:System.Web.Security.MembershipProvider.ResetPassword(System.String,System.String)" /> method of a membership provider is called.</para>
<para>You can handle the <see cref="E:System.Web.Security.MembershipProvider.ValidatingPassword" /> event to validate password formats and values for membership users.</para>
<para>You can cancel the current <see cref="M:System.Web.Security.MembershipProvider.CreateUser(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Object,System.Web.Security.MembershipCreateStatus@)" />, <see cref="M:System.Web.Security.MembershipProvider.ChangePassword(System.String,System.String,System.String)" />, or <see cref="M:System.Web.Security.MembershipProvider.ResetPassword(System.String,System.String)" /> action by setting the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.Cancel" /> property to true during the <see cref="E:System.Web.Security.MembershipProvider.ValidatingPassword" /> event.</para>
<para>If you cancel the current action by setting the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.Cancel" /> property to true, you can set the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.FailureInformation" /> property to an exception that describes the reason for the password-validation failure. The calling method will throw the exception that the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.FailureInformation" /> property is set to. If the <see cref="P:System.Web.Security.ValidatePasswordEventArgs.FailureInformation" /> property is null, the caller will throw a generic password-validation failure exception.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the password for the current create-user, change-password, or reset-password action.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="UserName">
<MemberSignature Language="C#" Value="public string UserName { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the name of the membership user for the current create-user, change-password, or reset-password action.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>
|