Upgrade your Internet Experience
Microsoft.com
Welcome Sign in
Microsoft Developer Network
Click to Rate and Give Feedback
MSDN
MSDN Library
.NET Development
.NET Framework 4
Collapse All/Expand All Collapse All
This page is specific to
Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:
.NET Framework Class Library
PasswordRecovery Class

Provides user interface (UI) elements that enable a user to recover or reset a lost password and receive it in e-mail.

 Inheritance Hierarchy
System..::.Object
  System.Web.UI..::.Control
    System.Web.UI.WebControls..::.WebControl
      System.Web.UI.WebControls..::.CompositeControl
        System.Web.UI.WebControls..::.PasswordRecovery

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)
 Syntax
Visual Basic 
<BindableAttribute(False)> _
Public Class PasswordRecovery _
    Inherits CompositeControl
C# 
[BindableAttribute(false)]
public class PasswordRecovery : CompositeControl
Visual C++ 
[BindableAttribute(false)]
public ref class PasswordRecovery : public CompositeControl
F# 
[<BindableAttribute(false)>]
type PasswordRecovery =  
    class
        inherit CompositeControl
    end
ASP.NET 
<asp:PasswordRecovery />

The PasswordRecovery type exposes the following members.

 Constructors
  NameDescription
Public methodPasswordRecoveryInitializes a new instance of the PasswordRecovery class.
Top
 Properties
  NameDescription
Public propertyAccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.)
Protected propertyAdapterGets the browser-specific adapter for the control. (Inherited from Control.)
Public propertyAnswerGets the answer to the password recovery confirmation question entered by the user.
Public propertyAnswerLabelTextGets or sets the label text for the password confirmation answer text box.
Public propertyAnswerRequiredErrorMessageGets or sets the error message displayed to the user when the Answer text box is blank.
Public propertyAppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
Public propertyAttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.)
Public propertyBackColorGets or sets the background color of the Web server control. (Inherited from WebControl.)
Public propertyBindingContainerInfrastructure. Gets the control that contains this control's data binding. (Inherited from Control.)
Public propertyBorderColorGets or sets the border color of the Web control. (Inherited from WebControl.)
Public propertyBorderPaddingGets or sets the amount of padding inside the borders of the PasswordRecovery control.
Public propertyBorderStyleGets or sets the border style of the Web server control. (Inherited from WebControl.)
Public propertyBorderWidthGets or sets the border width of the Web server control. (Inherited from WebControl.)
Protected propertyChildControlsCreatedGets a value that indicates whether the server control's child controls have been created. (Inherited from Control.)
Public propertyClientIDGets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.)
Public propertyClientIDModeGets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.)
Protected propertyClientIDSeparatorGets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
Protected propertyContextGets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
Public propertyControlsGets a ControlCollection object that represents the child controls in a CompositeControl. (Inherited from CompositeControl.)
Public propertyControlStyleGets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
Public propertyControlStyleCreatedGets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl.)
Public propertyCssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.)
Public propertyDataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.)
Public propertyDataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.)
Protected propertyDesignModeGets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
Public propertyEnabledGets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.)
Public propertyEnableThemingGets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.)
Public propertyEnableViewStateGets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control.)
Protected propertyEventsGets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
Public propertyFailureTextStyleGets a reference to a collection of properties that define the appearance of error text in the PasswordRecovery control.
Public propertyFontGets the font properties associated with the Web server control. (Inherited from WebControl.)
Public propertyForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.)
Public propertyGeneralFailureTextGets or sets the error message to display when there is a problem with the membership provider for the PasswordRecovery control.
Public propertyHasAttributesGets a value indicating whether the control has attributes set. (Inherited from WebControl.)
Protected propertyHasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
Public propertyHeightGets or sets the height of the Web server control. (Inherited from WebControl.)
Public propertyHelpPageIconUrlGets or sets the URL of an image to display next to the link to the Help page.
Public propertyHelpPageTextGets or sets the text of the link to the password recovery Help page.
Public propertyHelpPageUrlGets or sets the URL of the password recovery Help page.
Public propertyHyperLinkStyleGets a reference to a collection of properties that define the appearance of hyperlinks on the PasswordRecovery control.
Public propertyIDGets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
Protected propertyIdSeparatorInfrastructure. Gets the character used to separate control identifiers. (Inherited from Control.)
Public propertyInstructionTextStyleGets a reference to a collection of style properties that define the appearance of explanatory text in the PasswordRecovery control.
Protected propertyIsChildControlStateClearedGets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
Protected propertyIsEnabledGets a value indicating whether the control is enabled. (Inherited from WebControl.)
Protected propertyIsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
Protected propertyIsViewStateEnabledGets a value indicating whether view state is enabled for this control. (Inherited from Control.)
Public propertyLabelStyleGets a reference to a collection of style properties that define the appearance of text box labels in the PasswordRecovery control.
Protected propertyLoadViewStateByIDGets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
Public propertyMailDefinitionGets a reference to a collection of properties that define the characteristics of e-mail messages used to send new or recovered passwords to users.
Public propertyMembershipProviderGets or sets the membership provider used to look up user information.
Public propertyNamingContainerGets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control..::.ID property value. (Inherited from Control.)
Public propertyPageGets a reference to the Page instance that contains the server control. (Inherited from Control.)
Public propertyParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
Public propertyQuestionGets the password recovery confirmation question established by the user on the Web site.
Public propertyQuestionFailureTextGets or sets the text to display when the user's answer to the password recovery confirmation question does not match the answer stored in the Web site data store.
Public propertyQuestionInstructionTextGets or sets the text to display in the Question view to instruct the user to answer the password recovery confirmation question.
Public propertyQuestionLabelTextGets or sets the text of the label for the Question text box.
Public propertyQuestionTemplateGets or sets the template used to display the Question view of the PasswordRecovery control.
Public propertyQuestionTemplateContainerInfrastructure. Gets the container that a PasswordRecovery control used to create an instance of the QuestionTemplate template. This property provides programmatic access to child controls.
Public propertyQuestionTitleTextGets or sets the title for the Question view of the PasswordRecovery control.
Public propertyRenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.)
Public propertyRenderOuterTableGets or sets a value that indicates whether the control encloses rendered HTML in a table element in order to apply inline styles.
Public propertySiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
Public propertySkinIDGets or sets the skin to apply to the control. (Inherited from WebControl.)
Public propertyStyleGets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl.)
Public propertySubmitButtonImageUrlGets or sets the URL of an image to use as the Submit button.
Public propertySubmitButtonStyleGets a reference to a collection of properties that define the appearance of Submit buttons in the PasswordRecovery control.
Public propertySubmitButtonTextGets or sets the text of the button that submits the form.
Public propertySubmitButtonTypeGets or sets the type of Submit button to use when rendering the PasswordRecovery control.
Public propertySuccessPageUrlGets or sets the URL of the page to display after sending a password successfully.
Public propertySuccessTemplateGets or sets the template used to display the Success view of the PasswordRecovery control.
Public propertySuccessTemplateContainerInfrastructure. Gets the container that a PasswordRecovery control used to create an instance of the SuccessTemplate template. This property provides programmatic access to child controls.
Public propertySuccessTextGets or sets the text to display after sending a password successfully.
Public propertySuccessTextStyleGets a reference to a collection of style properties that define the appearance of text displayed in the Success view of the PasswordRecovery control.
Public propertySupportsDisabledAttributeGets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false. (Inherited from CompositeControl.)
Public propertyTabIndexGets or sets the tab index of the Web server control. (Inherited from WebControl.)
Protected propertyTagKeyGets the HtmlTextWriterTag value that corresponds to a PasswordRecovery control. (Overrides WebControl..::.TagKey.)
Protected propertyTagNameGets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.)
Public propertyTemplateControlGets or sets a reference to the template that contains this control. (Inherited from Control.)
Public propertyTemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
Public propertyTextBoxStyleGets a reference to a collection of style properties that define the appearance of text boxes in the PasswordRecovery control.
Public propertyTextLayoutGets or sets a value that specifies whether to display the PasswordRecovery control in a horizontal or vertical layout.
Public propertyTitleTextStyleGets a reference to a collection of style properties that define the appearance of title text that appears in the PasswordRecovery control.
Public propertyToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.)
Public propertyUniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
Public propertyUserNameGets or sets the text that appears in the User Name text box.
Public propertyUserNameFailureTextGets or sets the text displayed when the user name entered by the user is not a valid user name for the Web site.
Public propertyUserNameInstructionTextGets or sets the text to display in the UserName view of the PasswordRecovery control to instruct the user to enter a user name.
Public propertyUserNameLabelTextGets or sets the text of the label for the User Name text box.
Public propertyUserNameRequiredErrorMessageGets or sets the error message displayed when a user leaves the User Name text box empty.
Public propertyUserNameTemplateGets or sets the template used to display the UserName view of the PasswordRecovery control.
Public propertyUserNameTemplateContainerInfrastructure. Gets the container that a PasswordRecovery control used to create an instance of the UserNameTemplate template. This property provides programmatic access to child controls.
Public propertyUserNameTitleTextGets or sets the title for the UserName view of the PasswordRecovery control.
Public propertyValidatorTextStyleGets a reference to a collection of Style properties that define the appearance of error messages that are associated with any input validation used by the PasswordRecovery control.
Protected propertyViewStateGets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control.)
Protected propertyViewStateIgnoresCaseGets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
Public propertyViewStateModeGets or sets the view-state mode of this control. (Inherited from Control.)
Public propertyVisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.)
Public propertyWidthGets or sets the width of the Web server control. (Inherited from WebControl.)
Top
 Methods
  NameDescription
Protected methodAddAttributesToRenderAdds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from WebControl.)
Protected methodAddedControlCalled after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
Protected methodAddParsedSubObjectNotifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control.)
Public methodApplyStyleCopies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from WebControl.)
Public methodApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control. (Inherited from Control.)
Protected methodBuildProfileTreeInfrastructure. Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control.)
Protected methodClearCachedClientIDInfrastructure. Sets the cached ClientID value to nullNothingnullptra null reference (Nothing in Visual Basic). (Inherited from Control.)
Protected methodClearChildControlStateDeletes the control-state information for the server control's child controls. (Inherited from Control.)
Protected methodClearChildStateDeletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.)
Protected methodClearChildViewStateDeletes the view-state information for all the server control's child controls. (Inherited from Control.)
Protected methodClearEffectiveClientIDModeInfrastructure. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.)
Public methodCopyBaseAttributesCopies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from WebControl.)
Protected methodCreateChildControlsCreates the individual controls that make up the PasswordRecovery control. (Overrides Control..::.CreateChildControls()()().)
Protected methodCreateControlCollectionCreates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.)
Protected methodCreateControlStyleCreates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from WebControl.)
Public methodDataBind()()()Binds a data source to the CompositeControl and all its child controls. (Inherited from CompositeControl.)
Protected methodDataBind(Boolean)Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.)
Protected methodDataBindChildrenBinds a data source to the server control's child controls. (Inherited from Control.)
Public methodDisposeEnables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
Protected methodEnsureChildControlsDetermines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.)
Protected methodEnsureIDCreates an identifier for controls that do not have an identifier assigned. (Inherited from Control.)
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 methodFindControl(String)Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.)
Protected methodFindControl(String, Int32)Infrastructure. Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control.)
Public methodFocusSets input focus to a control. (Inherited from Control.)
Protected methodGetDesignModeStateInfrastructure. Gets design-time data for a control. (Inherited from Control.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetRouteUrl(Object)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public methodGetRouteUrl(RouteValueDictionary)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public methodGetRouteUrl(String, Object)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public methodGetRouteUrl(String, RouteValueDictionary)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetUniqueIDRelativeToReturns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.)
Public methodHasControlsDetermines if the server control contains any child controls. (Inherited from Control.)
Protected methodHasEventsReturns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.)
Protected methodIsLiteralContentInfrastructure. Determines if the server control holds only literal content. (Inherited from Control.)
Protected methodLoadControlStateInfrastructure. Implements the base Control..::.LoadControlState method. (Overrides Control..::.LoadControlState(Object).)
Protected methodLoadViewStateImplements the base Control..::.LoadViewState method. (Overrides WebControl..::.LoadViewState(Object).)
Protected methodMapPathSecureRetrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodMergeStyleCopies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from WebControl.)
Protected methodOnAnswerLookupErrorRaises the AnswerLookupError event.
Protected methodOnBubbleEventImplements the base Control..::.OnBubbleEvent method. (Overrides Control..::.OnBubbleEvent(Object, EventArgs).)
Protected methodOnDataBindingRaises the DataBinding event. (Inherited from Control.)
Protected methodOnInitInfrastructure. Implements the base Control..::.OnInit method. (Overrides Control..::.OnInit(EventArgs).)
Protected methodOnLoadRaises the Load event. (Inherited from Control.)
Protected methodOnPreRenderInfrastructure. Implements the base Control..::.OnPreRender method. (Overrides Control..::.OnPreRender(EventArgs).)
Protected methodOnSendingMailRaises the SendingMail event.
Protected methodOnSendMailErrorRaises the SendMailError event when an e-mail message cannot be sent to the user.
Protected methodOnUnloadRaises the Unload event. (Inherited from Control.)
Protected methodOnUserLookupErrorRaises the UserLookupError event.
Protected methodOnVerifyingAnswerRaises the VerifyingAnswer event.
Protected methodOnVerifyingUserRaises the VerifyingUser event.
Protected methodOpenFileGets a Stream used to read a file. (Inherited from Control.)
Protected methodRaiseBubbleEventAssigns any sources of the event and its information to the control's parent. (Inherited from Control.)
Protected methodRecreateChildControlsRecreates the child controls in a control derived from CompositeControl. (Inherited from CompositeControl.)
Protected methodRemovedControlCalled after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
Protected methodRenderWrites the CompositeControl content to the specified HtmlTextWriter object, for display on the client. (Overrides CompositeControl..::.Render(HtmlTextWriter).)
Public methodRenderBeginTagRenders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected methodRenderChildrenOutputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.)
Protected methodRenderContentsRenders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Public methodRenderControl(HtmlTextWriter)Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.)
Protected methodRenderControl(HtmlTextWriter, ControlAdapter)Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.)
Public methodRenderEndTagRenders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected methodResolveAdapterGets the control adapter responsible for rendering the specified control. (Inherited from Control.)
Public methodResolveClientUrlGets a URL that can be used by the browser. (Inherited from Control.)
Public methodResolveUrlConverts a URL into one that is usable on the requesting client. (Inherited from Control.)
Protected methodSaveControlStateImplements the base Control..::.SaveControlState method. (Overrides Control..::.SaveControlState()()().)
Protected methodSaveViewStateImplements the base Control..::.SaveViewState method. (Overrides WebControl..::.SaveViewState()()().)
Protected methodSetDesignModeStateImplements the base Control..::.IControlDesignerAccessor..::.SetDesignModeState method. (Overrides Control..::.SetDesignModeState(IDictionary).)
Public methodSetRenderMethodDelegateInfrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodTrackViewStateImplements the base Control..::.TrackViewState method. (Overrides WebControl..::.TrackViewState()()().)
Top
 Events
  NameDescription
Public eventAnswerLookupErrorOccurs when the user enters an incorrect answer to the password recovery confirmation question.
Public eventDataBindingOccurs when the server control binds to a data source. (Inherited from Control.)
Public eventDisposedOccurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control.)
Public eventInitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
Public eventLoadOccurs when the server control is loaded into the Page object. (Inherited from Control.)
Public eventPreRenderOccurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
Public eventSendingMailOccurs before the user is sent a password in e-mail.
Public eventSendMailErrorOccurs when the SMTP Mail system throws an error while attempting to send an e-mail message.
Public eventUnloadOccurs when the server control is unloaded from memory. (Inherited from Control.)
Public eventUserLookupErrorOccurs when the membership provider cannot find the user name entered by the user.
Public eventVerifyingAnswerOccurs when the user has submitted an answer to the password recovery confirmation question.
Public eventVerifyingUserOccurs before the user name is validated by the membership provider.
Top
 Extension Methods
  NameDescription
Public Extension MethodFindDataSourceControlReturns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.)
Public Extension MethodFindFieldTemplateReturns the field template for the specified column in the specified control's naming container. (Defined by DynamicDataExtensions.)
Public Extension MethodFindMetaTableReturns the metatable object for the containing data control. (Defined by DynamicDataExtensions.)
Top
 Fields
  NameDescription
Public fieldStatic memberSubmitButtonCommandNameRepresents the command to perform when the Submit button is clicked.
Top
 Explicit Interface Implementations
  NameDescription
Explicit interface implemetationPrivate methodIAttributeAccessor..::.GetAttributeInfrastructure. Gets an attribute of the Web control with the specified name. (Inherited from WebControl.)
Explicit interface implemetationPrivate methodIAttributeAccessor..::.SetAttributeSets an attribute of the Web control to the specified name and value. (Inherited from WebControl.)
Explicit interface implemetationPrivate methodICompositeControlDesignerAccessor..::.RecreateChildControlsEnables a designer to recreate the composite control's collection of child controls in the design-time environment. (Inherited from CompositeControl.)
Explicit interface implemetationPrivate propertyIControlBuilderAccessor..::.ControlBuilderFor a description of this member, see IControlBuilderAccessor..::.ControlBuilder. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor..::.GetDesignModeStateFor a description of this member, see IControlDesignerAccessor..::.GetDesignModeState. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor..::.SetDesignModeStateFor a description of this member, see IControlDesignerAccessor..::.SetDesignModeState. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor..::.SetOwnerControlInfrastructure. For a description of this member, see IControlDesignerAccessor..::.SetOwnerControl. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIControlDesignerAccessor..::.UserDataFor a description of this member, see IControlDesignerAccessor..::.UserData. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIDataBindingsAccessor..::.DataBindingsFor a description of this member, see IDataBindingsAccessor..::.DataBindings. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIDataBindingsAccessor..::.HasDataBindingsFor a description of this member, see IDataBindingsAccessor..::.HasDataBindings. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIExpressionsAccessor..::.ExpressionsFor a description of this member, see IExpressionsAccessor..::.Expressions. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIExpressionsAccessor..::.HasExpressionsFor a description of this member, see IExpressionsAccessor..::.HasExpressions. (Inherited from Control.)
Explicit interface implemetationPrivate methodIParserAccessor..::.AddParsedSubObjectFor a description of this member, see IParserAccessor..::.AddParsedSubObject. (Inherited from Control.)
Top
 Remarks

In this topic:

Introduction

The PasswordRecovery control assists users who have forgotten their passwords. It enables a user to request an e-mail message containing either a new password or the password already associated with his or her user name.

NoteNote

The PasswordRecovery Web control uses Internet e-mail services to send recovered or new passwords to users. There are inherent security risks with sending passwords in e-mail. You should determine whether these security risks are acceptable to your site.

NoteNote

If you are not familiar with the set of login controls available in ASP.NET, see ASP.NET Login Controls Overview before continuing. For a list of other topics related to login controls and membership, see Managing Users by Using Membership.

Users can recover passwords only when the membership provider defined in the MembershipProvider property supports clear text or encrypted passwords. Because hashed passwords cannot be recovered, users at sites that use hashed passwords can only reset their passwords.

Security noteSecurity Note

Accepting user input is a potential security threat. Malicious users can send data that is intended to expose vulnerabilities or run programs that try generated passwords. To improve security when working with user input, you should use the validation features of your control and secure any data providers that are configured for your control. For more information, see Securing Login Controls, Basic Security Practices for Web Applications, and Securing Membership.

NoteNote

The PasswordRecovery control can be used when a membership user has not been approved (MembershipUser..::.IsApproved is set to false), but it cannot be used when a membership user has been locked out (MembershipUser..::.IsLockedOut is set to true).

The e-mail message is sent using the MailDefinition class. To be able to send e-mail to users, you must configure a mail server in your application's Web.config file. You can change the content of the e-mail sent to users by setting a custom message in the MailDefinition property.

NoteNote

It is not possible to guarantee that a user will receive or view an e-mail message. To verify that a user has received a notification by e-mail, consider providing a confirmation link in the message, allowing the user to confirm that the notification was received.

Views

The PasswordRecovery control has three states, or views:

  • UserName view -- Asks the user for his or her registered user name.

  • Question view -- Requires the user to provide the answer to a stored question to reset the password.

  • Success view -- Tells the user whether the password recovery or reset was successful.

The PasswordRecovery control displays the Question view only when the membership provider defined in the MembershipProvider property supports password question and answer.

The following table lists each style property of the PasswordRecovery control and indicates which view it affects.

Property

UserName view

Question view

Success view

SubmitButtonStyle

Yes

Yes

Yes

FailureTextStyle

Yes

Yes

No

HyperLinkStyle

Yes

Yes

No

InstructionTextStyle

Yes

Yes

No

LabelStyle

Yes

Yes

No

SuccessTextStyle

No

No

Yes

TextBoxStyle

Yes

Yes

No

TitleTextStyle

Yes

Yes

Yes

Styles and Templates

You can use an extensive set of style properties to customize the appearance of the PasswordRecovery control. Alternatively, you can apply custom templates to the three views if you need complete control over the appearance of the control. You can use the QuestionTemplate, SuccessTemplate and UserNameTemplate properties to create templates for these views. If you define a template for a view, the style properties of PasswordRecovery have no effect.

The following table lists the PasswordRecovery control style properties and explains which UI element each style property affects. For a list of which properties each style applies to, see the documentation for the individual style properties.

Style property

UI element affected

SubmitButtonStyle

Submit buttons on all views.

FailureTextStyle

Error text displayed to the user.

HyperLinkStyle

Links to other pages.

InstructionTextStyle

Instructional text on the page that tells users how to use the control.

LabelStyle

Labels for all input fields, such as text boxes.

TextBoxStyle

Text entry input fields.

TitleTextStyle

Title text for each view.

SuccessTextStyle

Text displayed to the user when the password recovery or reset attempt is successful.

The following table lists which template properties apply to each view in the PasswordRecovery control. For a list of the controls that you must set in each template, see the documentation for the individual template properties.

View

Template property

UserName

UserNameTemplate

Question

QuestionTemplate

Success

SuccessTemplate

When the PasswordRecovery control is not customized with templates, the AccessKey property of the PasswordRecovery control applies to the first text box in the control and the TabIndex property, which is applied to all text boxes of the control. If the PasswordRecovery control is customized with templates, then the AccessKey property and the TabIndex property are ignored. In this case, set the AccessKey property and the TabIndex property of each template child control directly.

PasswordRecovery control properties represented by text boxes, such as Answer and Question, are accessible during all phases of the page life cycle. The control will pick up any changes made by the end user by means of the TextChanged event triggered by the textboxes.

Validation Groupings

The PasswordRecovery control creates a validation group for all required field validators in the control so that other input controls on the page are not affected by validating the PasswordRecovery control. By default, the ID property of the PasswordRecovery control is used as the name of the validation group. For example, a PasswordRecovery control with the ID "PasswordRecovery1" will use a validation group name of "PasswordRecovery1". If you want the PasswordRecovery control to participate in another validation group, you must template the control.

Applying CSS Styles

The PasswordRecovery control lets you specify CSS style rules in markup. If you use templates to customize the appearance of the PasswordRecovery control, you can specify CSS styles in the markup in the templates. In that case, no extra outer table is required. You can prevent the table from being rendered by setting the RenderOuterTable property to false.

Accessibility

For information about how to configure this control so that it generates markup that conforms to accessibility standards, see Accessibility in Visual Studio and ASP.NET and ASP.NET Controls and Accessibility.

Declarative Syntax

<asp:PasswordRecovery
    AccessKey="string"
    AnswerLabelText="string"
    AnswerRequiredErrorMessage="string"
    BackColor="color name|#dddddd"
    BorderColor="color name|#dddddd"
    BorderPadding="integer"
    BorderStyle="NotSet|None|Dotted|Dashed|Solid|Double|Groove|Ridge|
        Inset|Outset"
    BorderWidth="size"
    CssClass="string"
    Enabled="True|False"
    EnableTheming="True|False"
    EnableViewState="True|False"
    Font-Bold="True|False"
    Font-Italic="True|False"
    Font-Names="string"
    Font-Overline="True|False"
    Font-Size="string|Smaller|Larger|XX-Small|X-Small|Small|Medium|
        Large|X-Large|XX-Large"
    Font-Strikeout="True|False"
    Font-Underline="True|False"
    ForeColor="color name|#dddddd"
    GeneralFailureText="string"
    Height="size"
    HelpPageIconUrl="uri"
    HelpPageText="string"
    HelpPageUrl="uri"
    ID="string"
    MailDefinition-BodyFileName="uri"
    MailDefinition-CC="string"
    MailDefinition-From="string"
    MailDefinition-IsBodyHtml="True|False"
    MailDefinition-Priority="Normal|Low|High"
    MailDefinition-Subject="string"
    MembershipProvider="string"
    OnAnswerLookupError="AnswerLookupError event handler"
    OnDataBinding="DataBinding event handler"
    OnDisposed="Disposed event handler"
    OnInit="Init event handler"
    OnLoad="Load event handler"
    OnPreRender="PreRender event handler"
    OnSendingMail="SendingMail event handler"
    OnSendMailError="SendMailError event handler"
    OnUnload="Unload event handler"
    OnUserLookupError="UserLookupError event handler"
    OnVerifyingAnswer="VerifyingAnswer event handler"
    OnVerifyingUser="VerifyingUser event handler"
    QuestionFailureText="string"
    QuestionInstructionText="string"
    QuestionLabelText="string"
    QuestionTitleText="string"
    runat="server"
    SkinID="string"
    Style="string"
    SubmitButtonImageUrl="uri"
    SubmitButtonText="string"
    SubmitButtonType="Button|Image|Link"
    SuccessPageUrl="uri"
    SuccessText="string"
    TabIndex="integer"
    TextLayout="TextOnLeft|TextOnTop"
    ToolTip="string"
    UserName="string"
    UserNameFailureText="string"
    UserNameInstructionText="string"
    UserNameLabelText="string"
    UserNameRequiredErrorMessage="string"
    UserNameTitleText="string"
    Visible="True|False"
    Width="size"
>
        <FailureTextStyle />
        <HyperLinkStyle />
        <InstructionTextStyle />
        <LabelStyle />
        <MailDefinition
            BodyFileName="uri"
            CC="string"
            From="string"
            IsBodyHtml="True|False"
            Priority="Normal|Low|High"
            Subject="string"
>
                <EmbeddedObjects>
                        <asp:EmbeddedMailObject
                            Name="string"
                            Path="uri"
                        />
                </EmbeddedObjects>
        </MailDefinition>
        <QuestionTemplate>
            <!-- child controls -->
        </QuestionTemplate>
        <SubmitButtonStyle />
        <SuccessTemplate>
            <!-- child controls -->
        </SuccessTemplate>
        <SuccessTextStyle />
        <TextBoxStyle />
        <TitleTextStyle />
        <UserNameTemplate>
            <!-- child controls -->
        </UserNameTemplate>
        <ValidatorTextStyle />
</asp:PasswordRecovery>
TopicLocation
How to: Customize the PasswordRecovery ControlBuilding ASP .NET Web Applications
How to: Customize the PasswordRecovery ControlBuilding ASP .NET Web Applications
How to: Enable User Password Recovery Using the ASP.NET PasswordRecovery ControlBuilding ASP .NET Web Applications
How to: Enable User Password Recovery Using the ASP.NET PasswordRecovery ControlBuilding ASP .NET Web Applications
 Examples

The following code example demonstrates using the PasswordRecovery control.

Visual Basic 
<%@ 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">

    ' Set the field label background color if the user name is not found.
    Sub PasswordRecovery1_UserLookupError(ByVal sender As Object, ByVal e As System.EventArgs)
        PasswordRecovery1.LabelStyle.ForeColor = System.Drawing.Color.Red
    End Sub

    ' Reset the field label background color.
    Sub PasswordRecovery1_Load(ByVal sender As Object, ByVal e As System.EventArgs)
        PasswordRecovery1.LabelStyle.ForeColor = System.Drawing.Color.Black
    End Sub
</script>

<html  >
    <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
        <form id="form1" runat="server">
            <asp:PasswordRecovery id="PasswordRecovery1" runat="server" BorderStyle="Solid" BorderWidth="1px" BackColor="#F7F7DE"
                Font-Size="10pt" Font-Names="Verdana" BorderColor="#CCCC99" HelpPageText="Need help?" HelpPageUrl="recoveryHelp.aspx" onuserlookuperror="PasswordRecovery1_UserLookupError" onload="PasswordRecovery1_Load" >
                <successtemplate>
                    <table border="0" style="font-size:10pt;">
                        <tr>
                            <td>Your password has been sent to you.</td>
                        </tr>
                    </table>
                </successtemplate>
                <titletextstyle font-bold="True" forecolor="White" backcolor="#6B696B">
                </titletextstyle>
            </asp:PasswordRecovery>

        </form>
    </body>
</html>
C# 
<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

    // Set the field label background color if the user name is not found.
    void PasswordRecovery1_UserLookupError(object sender, System.EventArgs e)
    {
        PasswordRecovery1.LabelStyle.ForeColor = System.Drawing.Color.Red;
    }

    // Reset the field label background color.
    void PasswordRecovery1_Load(object sender, System.EventArgs e)
    {
        PasswordRecovery1.LabelStyle.ForeColor = System.Drawing.Color.Black;
    }
</script>

<html  >
    <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
        <form id="form1" runat="server">
            <asp:PasswordRecovery id="PasswordRecovery1" runat="server" BorderStyle="Solid" BorderWidth="1px" BackColor="#F7F7DE"
                Font-Size="10pt" Font-Names="Verdana" BorderColor="#CCCC99" HelpPageText="Need help?" HelpPageUrl="recoveryHelp.aspx" onuserlookuperror="PasswordRecovery1_UserLookupError" onload="PasswordRecovery1_Load" >
                <successtemplate>
                    <table border="0" style="font-size:10pt;">
                        <tr>
                            <td>Your password has been sent to you.</td>
                        </tr>
                    </table>
                </successtemplate>
                <titletextstyle font-bold="True" forecolor="White" backcolor="#6B696B">
                </titletextstyle>
            </asp:PasswordRecovery>

        </form>
    </body>
</html>
 Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0
 Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
 Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
 See Also

Reference

System.Web.UI.WebControls Namespace
MailDefinition

Other Resources

ASP.NET Login Controls Overview
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
© 2012 Microsoft. All rights reserved. Terms of Use | Trademarks | Privacy Statement
Page view tracker