Login.HelpPageUrl Property

Definition

Gets or sets the URL of the login Help page.

public:
 virtual property System::String ^ HelpPageUrl { System::String ^ get(); void set(System::String ^ value); };
public virtual string HelpPageUrl { get; set; }
member this.HelpPageUrl : string with get, set
Public Overridable Property HelpPageUrl As String

Property Value

String

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

Examples

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>
<%@ Page Language="VB" 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>

Remarks

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.

Applies to

See also