Login.OnAuthenticate Method
.NET Framework 3.0
Raises the Authenticate event to authenticate the user.
Namespace: System.Web.UI.WebControls
Assembly: System.Web (in system.web.dll)
Assembly: System.Web (in system.web.dll)
'Declaration Protected Overridable Sub OnAuthenticate ( _ e As AuthenticateEventArgs _ ) 'Usage Dim e As AuthenticateEventArgs Me.OnAuthenticate(e)
protected void OnAuthenticate ( AuthenticateEventArgs e )
protected function OnAuthenticate ( e : AuthenticateEventArgs )
Not applicable.
Parameters
- e
An AuthenticateEventArgs that contains the event data.
The OnAuthenticate method raises the Authenticate event. Use the Authenticate event to implement a custom authentication scheme.
Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.
The OnAuthenticate method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.
Notes to Inheritors: When overriding OnAuthenticate in a derived class, be sure to call the base class's OnAuthenticate method so that registered delegates receive the event.The following code example uses the Authenticate event to call site-specific custom authentication code.
<%@ page language="VB" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> ' This custom login control overloads the OnAuthenticate method ' to call a site-specific authentication method. Class CustomLogin Inherits Login Private Function SiteSpecificAuthenticationMethod(ByVal UserName As String, ByVal Password As String) As Boolean ' Insert code that implements a site-specific custom ' authentication method here. ' ' This example implementation always returns false. Return False End Function Overloads Sub OnAuthenticate(ByVal e As AuthenticateEventArgs) Dim Authenticated As Boolean Authenticated = SiteSpecificAuthenticationMethod(UserName, Password) e.Authenticated = Authenticated End Sub End Class ' Add the custom login control to the page. Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs) Dim loginControl As New CustomLogin loginControl.ID = "loginControl" PlaceHolder1.Controls.Add(loginControl) End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>ASP.NET Example</title> </head> <body> <form id="form1" runat="server"> <asp:placeholder id="PlaceHolder1" runat="server"></asp:placeholder> </form> </body> </html>
Community Additions
ADD
Show: