次の方法で共有

WebPart.HelpMode プロパティ

  • リファレンス

定義

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

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

public:
 virtual property System::Web::UI::WebControls::WebParts::WebPartHelpMode HelpMode { System::Web::UI::WebControls::WebParts::WebPartHelpMode get(); void set(System::Web::UI::WebControls::WebParts::WebPartHelpMode value); };
[System.Web.UI.Themeable(false)]
[System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)]
public virtual System.Web.UI.WebControls.WebParts.WebPartHelpMode HelpMode { get; set; }
[<System.Web.UI.Themeable(false)>]
[<System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)>]
member this.HelpMode : System.Web.UI.WebControls.WebParts.WebPartHelpMode with get, set
Public Overridable Property HelpMode As WebPartHelpMode

プロパティ値

WebPartHelpMode

WebPartHelpMode 値のいずれか 1 つ。 既定値は、Modal です。

属性
ThemeableAttribute PersonalizableAttribute

例外

ArgumentOutOfRangeException

指定された値が WebPartHelpMode 値ではありません。

例

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

注釈

コントロールの HelpMode ヘルプ コンテンツをブラウザーで表示する方法を決定するには、 プロパティを使用します。 次の表に、コントロールのヘルプ コンテンツが表示される場合のブラウザーでのさまざまなヘルプ モードの効果を WebPart 示します。

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

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

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

適用対象

こちらもご覧ください