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

HelpPageText 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 text of a link to the login Help page.

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

Syntax

Visual Basic (Declaration)

Public Overridable Property HelpPageText As String

Visual Basic (Usage)

Dim instance As Login
Dim value As String

value = instance.HelpPageText

instance.HelpPageText = value

public virtual string HelpPageText { get; set; }

Visual C++

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

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

JScript

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

ASP.NET

<asp:Login HelpPageText="String" />

Property Value

Type: System..::.String

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

Remarks

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.

Examples

The following code example uses the HelpPageText property to specify the text of a link to 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