This documentation is archived and is not being maintained.

Login.HelpPageUrl Property

Gets or sets the URL of the login Help page.

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

public virtual string HelpPageUrl { get; set; }
/** @property */
public String get_HelpPageUrl ()

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

public function get HelpPageUrl () : String

public function set HelpPageUrl (value : String)

Not applicable.

Property Value

The URL of the login Help page. The default is Empty.

The HelpPageUrl property contains the URL of the login Help page for the Web site. The HelpPageText property contains the text used for the link.

If HelpPageUrl is empty, text in the HelpPageText property is displayed to the user, but is not formatted as a link.

If the HelpPageText property is empty, the link to the login Help page is not available to the user.

The following code example uses the HelpPageUrl property to specify the URL of the site's login Help page.

<%@ Page Language="C#" AutoEventWireup="False"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
        <asp:Login id="Login1" runat="server" 
            HelpPageText="Help logging in..." 
            HelpPageUrl="loginHelp.aspx">
        </asp:Login>
    </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
Show: