1<?xml version="1.0" encoding="utf-8"?>
2<Type Name="AuthenticateEventArgs" FullName="System.Web.UI.WebControls.AuthenticateEventArgs">
3  <TypeSignature Language="C#" Value="public class AuthenticateEventArgs : EventArgs" />
4  <AssemblyInfo>
5    <AssemblyName>System.Web</AssemblyName>
6    <AssemblyVersion>2.0.0.0</AssemblyVersion>
7  </AssemblyInfo>
8  <Base>
9    <BaseTypeName>System.EventArgs</BaseTypeName>
10  </Base>
11  <Interfaces />
12  <Docs>
13    <since version=".NET 2.0" />
14    <remarks>
15      <attribution license="cc4" from="Microsoft" modified="false" />
16      <para>The <see cref="T:System.Web.UI.WebControls.AuthenticateEventArgs" /> class provides the data needed for the <see cref="E:System.Web.UI.WebControls.Login.Authenticate" /> event. Custom authentication schemes for a Web site use the <see cref="P:System.Web.UI.WebControls.AuthenticateEventArgs.Authenticated" /> property to  indicate whether a user's login attempt succeeded.</para>
17    </remarks>
18    <summary>
19      <attribution license="cc4" from="Microsoft" modified="false" />
20      <para>Provides data for the <see cref="E:System.Web.UI.WebControls.Login.Authenticate" /> event.</para>
21    </summary>
22  </Docs>
23  <Members>
24    <Member MemberName=".ctor">
25      <MemberSignature Language="C#" Value="public AuthenticateEventArgs ();" />
26      <MemberType>Constructor</MemberType>
27      <Parameters />
28      <Docs>
29        <remarks>To be added.</remarks>
30        <since version=".NET 2.0" />
31        <summary>
32          <attribution license="cc4" from="Microsoft" modified="false" />
33          <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.AuthenticateEventArgs" /> class with the <see cref="P:System.Web.UI.WebControls.AuthenticateEventArgs.Authenticated" /> property set to false.</para>
34        </summary>
35      </Docs>
36      <AssemblyInfo>
37        <AssemblyVersion>2.0.0.0</AssemblyVersion>
38      </AssemblyInfo>
39    </Member>
40    <Member MemberName=".ctor">
41      <MemberSignature Language="C#" Value="public AuthenticateEventArgs (bool authenticated);" />
42      <MemberType>Constructor</MemberType>
43      <Parameters>
44        <Parameter Name="authenticated" Type="System.Boolean" />
45      </Parameters>
46      <Docs>
47        <remarks>To be added.</remarks>
48        <since version=".NET 2.0" />
49        <summary>
50          <attribution license="cc4" from="Microsoft" modified="false" />
51          <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.AuthenticateEventArgs" /> class.</para>
52        </summary>
53        <param name="authenticated">
54          <attribution license="cc4" from="Microsoft" modified="false" />true if the user is authenticated; otherwise, false. </param>
55      </Docs>
56      <AssemblyInfo>
57        <AssemblyVersion>2.0.0.0</AssemblyVersion>
58      </AssemblyInfo>
59    </Member>
60    <Member MemberName="Authenticated">
61      <MemberSignature Language="C#" Value="public bool Authenticated { set; get; }" />
62      <MemberType>Property</MemberType>
63      <ReturnValue>
64        <ReturnType>System.Boolean</ReturnType>
65      </ReturnValue>
66      <Docs>
67        <value>To be added.</value>
68        <since version=".NET 2.0" />
69        <remarks>
70          <attribution license="cc4" from="Microsoft" modified="false" />
71          <para>Use the <see cref="P:System.Web.UI.WebControls.AuthenticateEventArgs.Authenticated" /> property in custom authentication schemes implemented in the <see cref="E:System.Web.UI.WebControls.Login.Authenticate" /> event handler to indicate the success or failure of the user's login attempt.</para>
72          <para>Setting the <see cref="P:System.Web.UI.WebControls.AuthenticateEventArgs.Authenticated" /> property to false indicates that the Web site user has not presented valid credentials and the <see cref="T:System.Web.UI.WebControls.Login" /> control should raise the <see cref="E:System.Web.UI.WebControls.Login.LoginError" /> event in addition to displaying text that indicates the login attempt was not successful. The <see cref="E:System.Web.UI.WebControls.Login.LoginError" /> event enables the page developer to have additional processes or action occur when user authentication is not successful. Setting <see cref="P:System.Web.UI.WebControls.AuthenticateEventArgs.Authenticated" /> to true indicates that the user has presented valid credentials and the <see cref="T:System.Web.UI.WebControls.Login" /> control should raise the <see cref="E:System.Web.UI.WebControls.Login.LoggedIn" /> event and redirect the user back to the current page or to the page indicated by <see cref="P:System.Web.UI.WebControls.Login.DestinationPageUrl" />.</para>
73        </remarks>
74        <summary>
75          <attribution license="cc4" from="Microsoft" modified="false" />
76          <para>Gets or sets a value indicating whether a user's authentication attempt succeeded.</para>
77        </summary>
78      </Docs>
79      <AssemblyInfo>
80        <AssemblyVersion>2.0.0.0</AssemblyVersion>
81      </AssemblyInfo>
82    </Member>
83  </Members>
84</Type>