CreateUserWizard.OnCreatingUser(LoginCancelEventArgs) Method

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Raises the CreatingUser event prior to calling the membership provider to create the new user account.

protected:
 virtual void OnCreatingUser(System::Web::UI::WebControls::LoginCancelEventArgs ^ e);

protected virtual void OnCreatingUser (System.Web.UI.WebControls.LoginCancelEventArgs e);

abstract member OnCreatingUser : System.Web.UI.WebControls.LoginCancelEventArgs -> unit
override this.OnCreatingUser : System.Web.UI.WebControls.LoginCancelEventArgs -> unit

Protected Overridable Sub OnCreatingUser (e As LoginCancelEventArgs)

Parameters

e: LoginCancelEventArgs

A LoginCancelEventArgs containing the event data.

Examples

The following code example defines a custom CreateUserWizard control that uses the OnCreatingUser method to make the UserName property all lowercase.

using System;
using System.Web;
using System.Web.UI.WebControls;
using System.Security.Permissions;

namespace Samples.AspNet.CS.Controls {
  [AspNetHostingPermission(System.Security.Permissions.SecurityAction.Demand,Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(System.Security.Permissions.SecurityAction.InheritanceDemand,Level = AspNetHostingPermissionLevel.Minimal)]
  public class CustomCreateUserWizard : CreateUserWizard {

    protected override void OnCreatingUser(LoginCancelEventArgs e) {
      this.UserName.ToLower();
      base.OnCreatingUser(e);
    }
  }
}

Imports System.Web
Imports System.Web.UI.WebControls
Imports System.Security.Permissions

Namespace Samples.AspNet.VB.Controls
  <AspNetHostingPermission(System.Security.Permissions.SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(System.Security.Permissions.SecurityAction.InheritanceDemand, Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class CustomCreateUserWizard
    Inherits CreateUserWizard
    
    Overloads Sub OnCreatingUser(ByVal e As LoginCancelEventArgs)
      Me.UserName.ToLower()
      MyBase.OnCreatingUser(e)
    End Sub    
    
  End Class
End Namespace

The following code example demonstrates a Web page that uses the CustomCreateUserWizard.

<%@ Page Language="C#"%>
<%@ Import namespace="Samples.AspNet.CS.Controls" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  void Page_Load(object sender, EventArgs e)
  {
    CustomCreateUserWizard createUser = new CustomCreateUserWizard();
    Placeholder1.Controls.Add(createUser);
  }

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>CreateUserWizard.OnCreatingUser sample</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:placeholder id="Placeholder1" runat="server">
      </asp:placeholder>
    </div>
    </form>
</body>
</html>

<%@ Page Language="VB"%>
<%@ Import namespace="Samples.AspNet.VB.Controls" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
  
  Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    Dim createUser As New CustomCreateUserWizard
    Placeholder1.Controls.Add(createUser)
  End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>CreateUserWizard.OnCreatingUser sample</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:placeholder id="Placeholder1" runat="server">
      </asp:placeholder>
    </div>
    </form>
</body>
</html>

Remarks

Use the OnCreatingUser method to do any processing required before sending the new user information to the CreateUser method of the membership provider specified in the MembershipProvider property. For example, you might set the user name field to all lowercase letters, or compare the email address to a list of restricted addresses before allowing creation of the user account.

If you need to cancel the request to create the new user account, set the Cancel property of the LoginCancelEventArgs object passed as the e parameter to true.

Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.

The OnCreatingUser 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 OnCreatingUser(LoginCancelEventArgs) in a derived class, be sure to call the base class' OnCreatingUser(LoginCancelEventArgs) method so that registered delegates receive the event.

Applies to