linux-packaging-mono/mcs/class/System.Web/Documentation/en/System.Web.Security/ValidatePasswordEventArgs.xml

<?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>