WebPart.HelpUrl Properti

Referensi

Definisi

Ruang nama:: System.Web.UI.WebControls.WebParts

Rakitan:: System.Web.dll

Penting

Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.

Mendapatkan atau mengatur URL ke file Bantuan untuk WebPart kontrol.

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

Nilai Properti

String

String yang mewakili URL ke file Bantuan. Nilai default adalah string kosong ("").

Atribut: ThemeableAttribute PersonalizableAttribute

Pengecualian

ArgumentException

Sistem validasi internal telah menentukan bahwa URL mungkin berisi serangan skrip.

Contoh

Contoh kode berikut menunjukkan penggunaan HelpUrl properti . Contoh ini mengasumsikan penggunaan kontrol kustom, TextDisplayWebPart, yang ditemukan di bagian Contoh dari WebPart gambaran umum kelas.

Contoh kode juga menyertakan halaman HTML yang berisi konten Bantuan fiktif untuk TextDisplayWebPart kontrol. Agar contoh ini berfungsi, Anda harus menyimpan kode berikut dalam file bernama Textwebparthelp.htm dan menempatkannya di direktori situs yang sama dengan halaman .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>

Bagian terakhir dari contoh adalah halaman Web yang memperlihatkan cara mereferensikan TextDisplayWebPart kontrol. Perhatikan bahwa dalam markup deklaratif, HelpMode nilai properti diatur ke Navigate, dan kode juga mengatur nilai HelpUrl properti ke nama file HTML yang berisi konten Bantuan. Muat halaman ke browser, dan klik kata kerja bantuan pada menu WebPart kata kerja kontrol.

<%@ 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>

Keterangan

Untuk mengaktifkan menu kata kerja dengan kata kerja bantuan di menu WebPart kata kerja kontrol, Anda harus memberikan nilai untuk HelpUrl properti . Cara konten Bantuan ditampilkan di browser ditentukan oleh nilai HelpMode properti .

Properti ini tidak dapat diatur oleh tema atau tema lembar gaya. Untuk informasi selengkapnya, lihat ThemeableAttribute dan ASP.NET Tema dan Kulit.

Cakupan personalisasi properti ini diatur ke Shared dan hanya dapat dimodifikasi oleh pengguna yang berwenang. Untuk informasi selengkapnya, lihat PersonalizableAttribute dan Gambaran Umum Personalisasi Bagian Web.

Berlaku untuk

Bagikan melalui