Export (0) Print
Expand All

MembershipUser Class

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

Namespace:  System.Web.Security
Assembly:  System.Web.ApplicationServices (in System.Web.ApplicationServices.dll)

[SerializableAttribute]
public class MembershipUser

The MembershipUser type exposes the following members.

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

  NameDescription
Public propertyCommentGets or sets application-specific information for the membership user.
Public propertyCreationDateGets the date and time when the user was added to the membership data store.
Public propertyEmailGets or sets the e-mail address for the membership user.
Public propertyIsApprovedGets or sets whether the membership user can be authenticated.
Public propertyIsLockedOutGets a value indicating whether the membership user is locked out and unable to be validated.
Public propertyIsOnlineGets whether the user is currently online.
Public propertyLastActivityDateGets or sets the date and time when the membership user was last authenticated or accessed the application.
Public propertyLastLockoutDateGets the most recent date and time that the membership user was locked out.
Public propertyLastLoginDateGets or sets the date and time when the user was last authenticated.
Public propertyLastPasswordChangedDateGets the date and time when the membership user's password was last updated.
Public propertyPasswordQuestionGets the password question for the membership user.
Public propertyProviderNameGets the name of the membership provider that stores and retrieves user information for the membership user.
Public propertyProviderUserKeyGets the user identifier from the membership data source for the user.
Public propertyUserNameGets the logon name of the membership user.
Top

  NameDescription
Public methodChangePasswordUpdates the password for the membership user in the membership data store.
Public methodChangePasswordQuestionAndAnswerUpdates the password question and answer for the membership user in the membership data store.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetPassword()Gets the password for the membership user from the membership data store.
Public methodGetPassword(String)Gets the password for the membership user from the membership data store.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodResetPassword()Resets a user's password to a new, automatically generated password.
Public methodResetPassword(String)Resets a user's password to a new, automatically generated password.
Public methodToStringReturns the user name for the membership user. (Overrides Object.ToString().)
Public methodUnlockUserClears the locked-out state of the user so that the membership user can be validated.
Top

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 e-mail address, and provides functionality for the membership user such as the ability to change or reset his or her password.

NoteNote

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.

TopicLocation
How to: Implement a Custom Membership UserBuilding ASP .NET Web Applications
How to: Implement a Custom Membership UserBuilding ASP .NET Web Applications

The following code example updates the e-mail address for a user.

Security noteSecurity Note

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 e-mail 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>E-mail 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 E-mail" 
                      OnClick="UpdateEmailButton_OnClick" 
                      runat="server" /></td>
    </tr>
  </table>
</form>

</body>
</html>

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft