WebPart.HelpUrl Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the URL to a Help file for a WebPart control.

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

public virtual string HelpUrl { get; set; }

Property Value

Type: System.String

A string that represents the URL to a Help file. The default value is an empty string ("").

Exception Condition

The internal validation system has determined that the URL might contain script attacks.

To enable a verb menu with a help verb in the verbs menu of a WebPart control, you must provide a value for the HelpUrl property. The manner in which the Help content is displayed in the browser is determined by the value of the HelpMode property.

This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and ASP.NET Themes and Skins.

The personalization scope of this property is set to Shared and can be modified only by authorized users. For more information, see PersonalizableAttribute and Web Parts Personalization Overview.

The following code example demonstrates the use of the HelpUrl property. This example assumes the use of a custom control, TextDisplayWebPart, which is found in the Example section of the WebPart class overview.

The code example also includes an HTML page that contains fictitious Help content for the TextDisplayWebPart control. For this example to work, you must save the following code in a file named Textwebparthelp.htm and place it in the same directory of your site as the .aspx page.

<head runat="server">
    <title>Text Content WebPart Help</title>
  <h1>Text Content WebPart Help</h1>
  To make the WebPart control work...

The final part of the example is a Web page that shows how to reference the TextDisplayWebPart control. Note that in the declarative markup, the HelpMode property value is set to Navigate, and the code also sets the value of the HelpUrl property to the name of the HTML file that contains the Help content. Load the page into a browser, and click the help verb on the verbs menu of the WebPart control.

<%@ page language="C#" %>
<%@ register tagprefix="aspSample" 
             Assembly="TextDisplayWebPartCS" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
          bordercolor="#81AAF2" />
            title = "Text Content WebPart" 
            HelpUrl="TextWebPartHelp.htm" />

.NET Framework
Available since 2.0
Return to top