Login.HelpPageUrl Property (System.Web.UI.WebControls)

HelpPageUrl Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Updated: November 2007

Gets or sets the URL of the login Help page.

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

Syntax

Visual Basic (Declaration)

Public Overridable Property HelpPageUrl As String

Visual Basic (Usage)

Dim instance As Login
Dim value As String

value = instance.HelpPageUrl

instance.HelpPageUrl = value

public virtual string HelpPageUrl { get; set; }

Visual C++

public:
virtual property String^ HelpPageUrl {
    String^ get ();
    void set (String^ value);
}

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

JScript

public function get HelpPageUrl () : String
public function set HelpPageUrl (value : String)

ASP.NET

<asp:Login HelpPageUrl="String" />

Property Value

Type: System..::.String

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

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.

Examples

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

Visual Basic

<%@ 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  >
<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="C#" AutoEventWireup="False"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html  >
<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>

Platforms

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

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

Version Information