WebPart.HelpUrl Proprietà

Riferimento

Definizione

Spazio dei nomi:: System.Web.UI.WebControls.WebParts

Assembly:: System.Web.dll

Importante

Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.

Ottiene o imposta l'URL di una file della Guida relativo a un controllo WebPart.

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; }

[<System.Web.UI.Themeable(false)>]
[<System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)>]
member this.HelpUrl : string with get, set

Public Overridable Property HelpUrl As String

Valore della proprietà

String

Stringa che rappresenta l'URL di un file della Guida. Il valore predefinito è una stringa vuota ("").

Attributi: ThemeableAttribute PersonalizableAttribute

Eccezioni

ArgumentException

Il sistema di convalida interno ha determinato che l'URL può contenere attacchi con script.

Esempio

Nell'esempio di codice seguente viene illustrato l'uso HelpUrl della proprietà. In questo esempio si presuppone l'uso di un controllo personalizzato, , TextDisplayWebPartdisponibile nella sezione Esempio della panoramica della WebPart classe.

L'esempio di codice include anche una pagina HTML contenente contenuto fittizio della Guida per il TextDisplayWebPart controllo. Per il funzionamento di questo esempio, è necessario salvare il codice seguente in un file denominato Textwebparthelp.htm e inserirlo nella stessa directory del sito della pagina aspx.

<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 che mostra come fare riferimento al TextDisplayWebPart controllo. Si noti che nel markup dichiarativo il HelpMode valore della proprietà è impostato su Navigatee il codice imposta anche il valore della HelpUrl proprietà sul nome del file HTML che contiene il contenuto della Guida. Caricare la pagina in un browser e fare clic sul verbo della Guida nel menu verbi del WebPart controllo.

<%@ 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 verbo con un verbo della Guida nel menu verbi di un WebPart controllo, è necessario specificare un valore per la HelpUrl proprietà. Il modo in cui viene visualizzato il contenuto della Guida nel browser è determinato dal valore della HelpMode proprietà.

Questa proprietà non può essere impostata da temi oppure temi di fogli di stile. Per altre informazioni, vedere ThemeableAttribute e ASP.NET Temi e skin.

L'ambito di personalizzazione di questa proprietà è impostato su Shared e può essere modificato solo dagli utenti autorizzati. Per altre informazioni, vedere PersonalizableAttribute e Panoramica sulla personalizzazione delle web part.

Si applica a