WebPart.HelpUrl プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

WebPart.HelpUrl プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Web.UI.WebControls.WebParts
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

<ThemeableAttribute(False)> _
Public Overridable Property
 HelpUrl As String

Visual Basic (使用法)

Dim instance As WebPart
Dim value As String

value = instance.HelpUrl

instance.HelpUrl = value

[ThemeableAttribute(false)] 
public virtual string HelpUrl { get;
 set; }

C++

[ThemeableAttribute(false)] 
public:
virtual property String^ HelpUrl {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_HelpUrl ()

/** @property */
public void set_HelpUrl (String value)

JScript

public function get HelpUrl
 () : String

public function set HelpUrl
 (value : String)

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

解説

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

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

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

使用例

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

コード例には、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 コントロールの動詞メニューの help 動詞をクリックします。

Visual Basic

<%@ page language="VB" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.VB.Controls"
 
             Assembly="TextDisplayWebPartVB"
 %>

<html>
<head id="Head1" runat="server">
</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="C#" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.CS.Controls" 
             Assembly="TextDisplayWebPartCS" %>

<html>
<head id="Head1" runat="server">
</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="VJ#" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.JSL.Controls" 
             Assembly="TextDisplayWebPartJSL" %>

<html>
<head id="Head1" runat="server">
</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>