Language

WebPart.HelpUrl プロパティ

定義

名前空間:
System.Web.UI.WebControls.WebParts
アセンブリ:
System.Web.dll

WebPart コントロールのヘルプ ファイルの URL を取得または設定します。

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

プロパティ値

String

ヘルプ ファイルの URL を表す文字列。 既定値は空の文字列 ("") です。

属性
ThemeableAttribute PersonalizableAttribute

例外

ArgumentException

内部検証システムは、URL にスクリプト攻撃が含まれている可能性があると判断しました。

例

次のコード例では、 HelpUrl プロパティの使用方法を示します。 この例では、TextDisplayWebPart クラスの概要の「例」セクションにあるカスタム コントロール (WebPart) を使用することを前提としています。

このコード例には、 TextDisplayWebPart コントロールの架空のヘルプ コンテンツを含む HTML ページも含まれています。 この例を機能させるには、次のコードを Textwebparthelp.htm という名前のファイルに保存し、.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>

この例の最後の部分は、 TextDisplayWebPart コントロールを参照する方法を示す Web ページです。 宣言型マークアップでは、 HelpMode プロパティの値が Navigate に設定され、コードでは、 HelpUrl プロパティの値もヘルプ コンテンツを含む HTML ファイルの名前に設定されることに注意してください。 ブラウザーにページを読み込み、 WebPart コントロールの動詞メニューのヘルプ動詞をクリックします。

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

注釈

WebPart コントロールの動詞メニューでヘルプ動詞を使用して動詞メニューを有効にするには、HelpUrl プロパティの値を指定する必要があります。 ブラウザーにヘルプ コンテンツを表示する方法は、 HelpMode プロパティの値によって決まります。

このプロパティは、テーマまたはスタイル シートのテーマでは設定できません。 詳細については、「テーマとスキンの ThemeableAttribute と ASP.NET」を参照してください。

このプロパティのパーソナル化スコープは Shared に設定され、承認されたユーザーのみが変更できます。 詳細については、「 PersonalizableAttribute と Web パーツのパーソナル化の概要」を参照してください。

適用対象

こちらもご覧ください