次の方法で共有

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 ページです。 宣言型マークアップでは、 プロパティの値が にNavigate設定され、HelpModeプロパティの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 値によって決まります。

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

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

適用対象

こちらもご覧ください