Login.HelpPageText Property

Definition

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

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

Property Value

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

Examples

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"%>
<!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 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 Globalization and Localization.

Applies to

See also