WebPartHelpMode

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

WebPart.HelpMode プロパティ

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

WebPart コントロールのヘルプ内容の表示に使用されるユーザー インターフェイス (UI) の種類を取得または設定します。

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

Visual Basic (宣言)

<ThemeableAttribute(False)> _
Public Overridable Property
 HelpMode As WebPartHelpMode

Visual Basic (使用法)

Dim instance As WebPart
Dim value As WebPartHelpMode

value = instance.HelpMode

instance.HelpMode = value

C#

[ThemeableAttribute(false)] 
public virtual WebPartHelpMode HelpMode { get;
 set; }

C++

[ThemeableAttribute(false)] 
public:
virtual property WebPartHelpMode HelpMode {
    WebPartHelpMode get ();
    void set (WebPartHelpMode value);
}

J#

/** @property */
public WebPartHelpMode get_HelpMode ()

/** @property */
public void set_HelpMode (WebPartHelpMode value)

JScript

public function get HelpMode
 () : WebPartHelpMode

public function set HelpMode
 (value : WebPartHelpMode)

プロパティ値
WebPartHelpMode 値の 1 つ。既定値は Modal です。

例外

例外の種類	条件
ArgumentOutOfRangeException	指定された値が WebPartHelpMode 値ではありません。

解説

HelpMode プロパティを使用して、ブラウザがコントロールのヘルプ内容を表示する方法を決定します。WebPart コントロールのヘルプ内容が表示されるときに、さまざまなヘルプ モードがブラウザに与える影響の一覧を次の表に示します。

ヘルプ モード	ブラウザの動作
Modal	ブラウザで別のブラウザ ウィンドウを開くことができる場合は、それを開きます。ユーザーは、Web パーツ ページに戻る前にウィンドウを終了する必要があります。
Modeless	ブラウザで別のブラウザ ウィンドウを開くことができる場合は、それを開きます。ユーザーは、Web ページに戻る前にウィンドウを閉じる必要はありません。
Navigate	ブラウザ ウィンドウ内の Web パーツ ページを置き換えます。

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

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

使用例

HelpMode プロパティを使用して、同じブラウザ ウィンドウにコントロールのヘルプを表示する方法を次のコード例に示します。この例の最初の部分は、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>

C#

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

J#

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
WebPart クラス
WebPart メンバ
System.Web.UI.WebControls.WebParts 名前空間
HelpUrl
その他の技術情報
ASP.NET Web パーツ ページ

WebPartHelpMode 列挙体

メモ : この列挙体は、.NET Framework version 2.0 で新しく追加されたものです。

WebPart コントロールのヘルプの内容を表示するために使用できるユーザー インターフェイス (UI) の種類を指定します。

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

Visual Basic (宣言)

Public Enumeration WebPartHelpMode

Visual Basic (使用法)

Dim instance As WebPartHelpMode

C#

public enum WebPartHelpMode

C++

public enum class WebPartHelpMode

J#

public enum WebPartHelpMode

JScript

public enum WebPartHelpMode

メンバ

	メンバ名	説明
	Modal	ブラウザにこの機能がある場合に、別のブラウザ ウィンドウを開きます。Web パーツ ページに戻る前には、このウィンドウを閉じる必要があります。
	Modeless	ブラウザにこの機能がある場合に、別のブラウザ ウィンドウを開きます。Web ページに戻る前にこのウィンドウを閉じる必要はありません。
	Navigate	ブラウザ ウィンドウ内の Web パーツ ページを置き換えます。

解説

HelpMode プロパティは、ブラウザがコントロールのヘルプの内容を表示する方法を決定するために使用されます。WebPartHelpMode 列挙体には、HelpMode プロパティに適用できる値が格納されています。HelpMode プロパティの既定値は Modal です。

使用例

HelpMode プロパティを使用して、コントロールのヘルプを同じブラウザ ウィンドウに表示するコード例を次に示します。この例の最初の部分は、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>

C#

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

J#

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
System.Web.UI.WebControls.WebParts 名前空間