WebPart.HelpMode Proprietà

  • Riferimento

Definizione

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

Ottiene o imposta il tipo di interfaccia utente utilizzato per visualizzare la Guida relativa a un controllo WebPart.

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

Valore della proprietà

WebPartHelpMode

Uno dei valori di WebPartHelpMode. Il valore predefinito è Modal.

Attributi
ThemeableAttribute PersonalizableAttribute

Eccezioni

ArgumentOutOfRangeException

Il valore specificato non è uno dei valori di WebPartHelpMode.

Esempio

Nell'esempio HelpMode di codice seguente viene illustrato l'uso della proprietà per visualizzare la Guida per un controllo nella stessa finestra del browser. La prima parte di questo esempio 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

Usare la proprietà per determinare la modalità di visualizzazione del contenuto della HelpMode Guida per un controllo. La tabella seguente elenca gli effetti delle varie modalità della Guida in un browser quando viene visualizzato il contenuto della Guida per un WebPart controllo.

Modalità Guida Comportamento dei browser
Modal Apre una finestra separata del browser, se il browser offre questa funzionalità. L'utente deve chiudere la finestra prima di tornare alla pagina Web part.
Modeless Apre una finestra separata del browser, se il browser offre questa funzionalità. L'utente non deve chiudere la finestra prima di tornare alla pagina Web.
Navigate Sostituisce la pagina Web part nella finestra del browser.

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 Web part Panoramica della personalizzazione.

Si applica a

Vedi anche