File: AuthenticateEventArgs.xml

package info (click to toggle)
mono 6.14.1%2Bds2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,282,732 kB
  • sloc: cs: 11,182,461; xml: 2,850,281; ansic: 699,123; cpp: 122,919; perl: 58,604; javascript: 30,841; asm: 21,845; makefile: 19,602; sh: 10,973; python: 4,772; pascal: 925; sql: 859; sed: 16; php: 1
file content (84 lines) | stat: -rw-r--r-- 5,024 bytes parent folder | download | duplicates (8)
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
<?xml version="1.0" encoding="utf-8"?>
<Type Name="AuthenticateEventArgs" FullName="System.Web.UI.WebControls.AuthenticateEventArgs">
  <TypeSignature Language="C#" Value="public class AuthenticateEventArgs : 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="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>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Provides data for the <see cref="E:System.Web.UI.WebControls.Login.Authenticate" /> event.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public AuthenticateEventArgs ();" />
      <MemberType>Constructor</MemberType>
      <Parameters />
      <Docs>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <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>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public AuthenticateEventArgs (bool authenticated);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="authenticated" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.AuthenticateEventArgs" /> class.</para>
        </summary>
        <param name="authenticated">
          <attribution license="cc4" from="Microsoft" modified="false" />true if the user is authenticated; otherwise, false. </param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Authenticated">
      <MemberSignature Language="C#" Value="public bool Authenticated { 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>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>
          <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>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets a value indicating whether a user's authentication attempt succeeded.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
</Type>