WebPartHelpMode 列挙型

  • リファレンス

定義

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

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

public enum class WebPartHelpMode
public enum WebPartHelpMode
type WebPartHelpMode = 
Public Enum WebPartHelpMode
継承
Object
ValueType
Enum
WebPartHelpMode

フィールド

Modal 0

ブラウザーにこの機能がある場合に、別のブラウザー ウィンドウを開きます。 Web パーツ ページに戻る前には、このウィンドウを閉じる必要があります。
Modeless 1

ブラウザーにこの機能がある場合に、別のブラウザー ウィンドウを開きます。 ユーザーは、Web ページに戻る前にウィンドウを閉じる必要はありません。
Navigate 2

ブラウザー ウィンドウ内の Web パーツ ページを置き換えます。

例

次の WebPart.HelpMode 例では、プロパティを使用して、同じブラウザー ウィンドウにコントロールのヘルプを表示します。 この例の最初の部分では、 TextDisplayWebPartクラスの Examples セクションにあるカスタム コントロールを 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され、WebPart.HelpModeコードでは、プロパティのWebPart.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>

注釈

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

適用対象