This documentation is archived and is not being maintained.

Login.HelpPageText Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets the text of a link to the login Help page.

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

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)

Property Value

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

The HelpPageText property contains the link text to the login Help page for the site. The URL of the login Help page is specified in the HelpPageUrl property.

If HelpPageUrl is empty, the text in the HelpPageText property is displayed to the user on the page, 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 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 specify the text of a link to the site's login Help page.

<%@ Page Language="C#" AutoEventWireup="False"%>
    <form runat="server">
        <asp:Login id="Login1" runat="server" 
            HelpPageText="Help logging in..." 

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

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

.NET Framework

Supported in: 2.0