MembershipUser Class

Reference

Definition

Namespace:: System.Web.Security

Assembly:: System.Web.dll

Assembly:: System.Web.ApplicationServices.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.

Exposes and updates membership user information in the membership data store.

public ref class MembershipUser

[System.Serializable]
public class MembershipUser

[<System.Serializable>]
type MembershipUser = class

Public Class MembershipUser

Inheritance: Object
MembershipUser

Derived: System.Web.Security.ActiveDirectoryMembershipUser

Attributes: SerializableAttribute

Examples

The following code example updates the email address for a user.

Important

This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

MembershipUser u;

public void Page_Load(object sender, EventArgs args)
{
  u = Membership.GetUser(User.Identity.Name);

  if (!IsPostBack)
  {
    EmailTextBox.Text = u.Email; 
  }
}

public void UpdateEmailButton_OnClick(object sender, EventArgs args)
{
  try
  {
    u.Email = EmailTextBox.Text;

    Membership.UpdateUser(u);
  
    Msg.Text = "User email updated.";
  }
  catch (System.Configuration.Provider.ProviderException e)
  {
    Msg.Text = e.Message;
  }
}

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: Update User E-Mail</title>
</head>
<body>

<form id="form1" runat="server">
  <h3>Update E-Mail Address for <%=User.Identity.Name%></h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <table cellpadding="3" border="0">
    <tr>
      <td>Email Address:</td>
      <td><asp:TextBox id="EmailTextBox" MaxLength="128" Columns="30" runat="server" /></td>
      <td><asp:RequiredFieldValidator id="EmailRequiredValidator" runat="server"
                                    ControlToValidate="EmailTextBox" ForeColor="red"
                                    Display="Static" ErrorMessage="Required" /></td>
    </tr>
    <tr>
      <td></td>
      <td><asp:Button id="UpdateEmailButton" 
                      Text="Update Email" 
                      OnClick="UpdateEmailButton_OnClick" 
                      runat="server" /></td>
    </tr>
  </table>
</form>

</body>
</html>

<%@ Page Language="vb" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

Dim u As MembershipUser

Public Sub Page_Load(sender As Object, args As EventArgs)

  u = Membership.GetUser(User.Identity.Name)

  If Not IsPostBack Then EmailTextBox.Text = u.Email

End Sub

Public Sub UpdateEmailButton_OnClick(sender As Object, args As EventArgs)

  Try
    u.Email = EmailTextBox.Text

    Membership.UpdateUser(u)
  
    Msg.Text = "User email updated."
  Catch e As System.Configuration.Provider.ProviderException
    Msg.Text = e.Message
  End Try

End Sub

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: Update User E-Mail</title>
</head>
<body>

<form id="form1" runat="server">
  <h3>Update E-Mail Address for <%=User.Identity.Name%></h3>

  <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />

  <table cellpadding="3" border="0">
    <tr>
      <td>Email Address:</td>
      <td><asp:TextBox id="EmailTextBox" MaxLength="128" Columns="30" runat="server" /></td>
      <td><asp:RequiredFieldValidator id="EmailRequiredValidator" runat="server"
                                    ControlToValidate="EmailTextBox" ForeColor="red"
                                    Display="Static" ErrorMessage="Required" /></td>
    </tr>
    <tr>
      <td></td>
      <td><asp:Button id="UpdateEmailButton" 
                      Text="Update Email" 
                      OnClick="UpdateEmailButton_OnClick" 
                      runat="server" /></td>
    </tr>
  </table>
</form>

</body>
</html>

Remarks

The MembershipUser object is used to represent a single membership user in the membership data store. It exposes information about the membership user such as the email address, and provides functionality for the membership user such as the ability to change or reset their password.

Note

If you are not familiar with the membership features of ASP.NET, see Introduction to Membership before continuing. For a list of other topics related to membership, see Managing Users by Using Membership.

A MembershipUser object is returned by the GetUser and CreateUser methods or as part of a MembershipUserCollection returned by the GetAllUsers, FindUsersByName, and FindUsersByEmail methods.

A MembershipUser object is required by the UpdateUser method when you want to update the information for an existing membership user.

Constructors

MembershipUser()	Creates a new instance of a MembershipUser object for a class that inherits the MembershipUser class.
MembershipUser(String, String, Object, String, String, String, Boolean, Boolean, DateTime, DateTime, DateTime, DateTime, DateTime)	Creates a new membership user object with the specified property values.

Properties

Comment	Gets or sets application-specific information for the membership user.
CreationDate	Gets the date and time when the user was added to the membership data store.
Email	Gets or sets the email address for the membership user.
IsApproved	Gets or sets whether the membership user can be authenticated.
IsLockedOut	Gets a value indicating whether the membership user is locked out and unable to be validated.
IsOnline	Gets whether the user is currently online.
LastActivityDate	Gets or sets the date and time when the membership user was last authenticated or accessed the application.
LastLockoutDate	Gets the most recent date and time that the membership user was locked out.
LastLoginDate	Gets or sets the date and time when the user was last authenticated.
LastPasswordChangedDate	Gets the date and time when the membership user's password was last updated.
PasswordQuestion	Gets the password question for the membership user.
ProviderName	Gets the name of the membership provider that stores and retrieves user information for the membership user.
ProviderUserKey	Gets the user identifier from the membership data source for the user.
UserName	Gets the logon name of the membership user.

Methods

ChangePassword(String, String)	Updates the password for the membership user in the membership data store.
ChangePasswordQuestionAndAnswer(String, String, String)	Updates the password question and answer for the membership user in the membership data store.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetPassword()	Gets the password for the membership user from the membership data store.
GetPassword(String)	Gets the password for the membership user from the membership data store.
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ResetPassword()	Resets a user's password to a new, automatically generated password.
ResetPassword(String)	Resets a user's password to a new, automatically generated password.
ToString()	Returns the user name for the membership user.
UnlockUser()	Clears the locked-out state of the user so that the membership user can be validated.

Applies to

Jaa