PasswordRecovery.HelpPageText Property

Gets or sets the text of the link to the password recovery Help page.

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in system.web.dll)

[LocalizableAttribute(true)] 
public virtual string HelpPageText { get; set; }
/** @property */
public String get_HelpPageText ()

/** @property */
public void set_HelpPageText (String value)

public function get HelpPageText () : String

public function set HelpPageText (value : String)

Not applicable.

Property Value

The text of the link to the password recovery Help page. The default is Empty.

The HelpPageText property contains the link text for the password recovery Help page. If a URL is specified in the HelpPageText property, the PasswordRecovery control displays a link to information about password recovery in the UserName view and the Question view, but not in the Success view.

If the HelpPageUrl property is set to Empty, no link is displayed.

The appearance of the Help page link is defined by the HyperLinkStyle property.

When you use templates to define the appearance of the PasswordRecovery control, the HelpPageText and HelpPageUrl properties have no effect.

The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see LocalizableAttribute and ASP.NET Globalization and Localization.

The following code example uses the HelpPageText property to link to a Help page. If the user does not enter his or her user name properly, the UserLookupError event handler is used to highlight the link.

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

    void PasswordRecovery1_UserLookupError(object sender, EventArgs e)
    {
        PasswordRecovery1.HelpPageText = "Need help with recovering your password?";
        PasswordRecovery1.HyperLinkStyle.BackColor = System.Drawing.Color.DarkGreen;
        PasswordRecovery1.HyperLinkStyle.ForeColor = System.Drawing.Color.White;
    }
    
</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:passwordrecovery id="PasswordRecovery1" runat="server"
      helppagetext="Help with recovering your password" 
      helppageurl="recoveryHelp.aspx" OnUserLookupError="PasswordRecovery1_UserLookupError">
        <hyperlinkstyle backcolor="#E0E0E0"></hyperlinkstyle>
    </asp:passwordrecovery>

</form>
</body>
</html>

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show: