WebPart.HelpUrl Proprietà

Definizione

Ottiene o imposta l'URL di una file della Guida relativo a un controllo WebPart.Gets or sets the URL to a Help file for a WebPart control.

public:
 virtual property System::String ^ HelpUrl { System::String ^ get(); void set(System::String ^ value); };
[System.Web.UI.Themeable(false)]
[System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)]
public virtual string HelpUrl { get; set; }
member this.HelpUrl : string with get, set
Public Overridable Property HelpUrl As String

Valore della proprietà

Stringa che rappresenta l'URL di un file della Guida.A string that represents the URL to a Help file. Il valore predefinito è una stringa vuota ("").The default value is an empty string ("").

Attributi

Eccezioni

Il sistema di convalida interno ha determinato che l'URL può contenere attacchi con script.The internal validation system has determined that the URL might contain script attacks.

Esempi

Nell'esempio di codice riportato di seguito viene illustrato l'utilizzo della proprietà HelpUrl.The following code example demonstrates the use of the HelpUrl property. Questo esempio presuppone l'uso di un controllo personalizzato, TextDisplayWebPart, presente nella sezione di esempio della panoramica della classe WebPart.This example assumes the use of a custom control, TextDisplayWebPart, which is found in the Example section of the WebPart class overview.

Nell'esempio di codice è inclusa anche una pagina HTML contenente contenuto della Guida fittizio per il controllo TextDisplayWebPart.The code example also includes an HTML page that contains fictitious Help content for the TextDisplayWebPart control. Per il corretto funzionamento di questo esempio, è necessario salvare il codice seguente in un file denominato Textwebparthelp. htm e posizionarlo nella stessa directory del sito della pagina aspx.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.

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

La parte finale dell'esempio è una pagina Web in cui viene illustrato come fare riferimento al controllo TextDisplayWebPart.The final part of the example is a Web page that shows how to reference the TextDisplayWebPart control. Si noti che nel markup dichiarativo, il valore della proprietà HelpMode è impostato su Navigatee il codice imposta anche il valore della proprietà HelpUrl sul nome del file HTML che contiene il contenuto della guida.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. Caricare la pagina in un browser, quindi fare clic sul verbo della guida nel menu dei verbi del controllo WebPart.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" 
             Namespace="Samples.AspNet.CS.Controls" 
             Assembly="TextDisplayWebPartCS" %>

<!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 id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" 
            width="350px" 
            HelpMode="navigate"
            HelpUrl="TextWebPartHelp.htm" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>
<%@ page language="VB" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.VB.Controls" 
             Assembly="TextDisplayWebPartVB" %>

<!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 id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      backcolor="#99cccc">
        <parttitlestyle font-bold="true" forecolor="#ffffff" />
        <partstyle
          borderwidth="1px" 
          borderstyle="Solid" 
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" 
            width="350px" 
            HelpMode="navigate"
            HelpUrl="TextWebPartHelp.htm" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

Commenti

Per abilitare un menu dei verbi con un verbo della guida nel menu dei verbi di un controllo WebPart, è necessario specificare un valore per la proprietà HelpUrl.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. Il modo in cui il contenuto della guida viene visualizzato nel browser è determinato dal valore della proprietà HelpMode.The manner in which the Help content is displayed in the browser is determined by the value of the HelpMode property.

Questa proprietà non può essere impostata da temi oppure temi di fogli di stile.This property cannot be set by themes or style sheet themes. Per ulteriori informazioni, vedere i temi e le interfaccedi ThemeableAttribute e ASP.NET.For more information, see ThemeableAttribute and ASP.NET Themes and Skins.

L'ambito di personalizzazione di questa proprietà è impostato su Shared e può essere modificato solo da utenti autorizzati.The personalization scope of this property is set to Shared and can be modified only by authorized users. Per ulteriori informazioni, vedere PersonalizableAttribute e Web part Cenni preliminari sulla personalizzazione.For more information, see PersonalizableAttribute and Web Parts Personalization Overview.

Si applica a

Vedi anche