WebPartManager.DisplayMode プロパティ

  • リファレンス

定義

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

Web パーツ コントロールが含まれた Web ページのアクティブな表示モードを取得または設定します。

public:
 virtual property System::Web::UI::WebControls::WebParts::WebPartDisplayMode ^ DisplayMode { System::Web::UI::WebControls::WebParts::WebPartDisplayMode ^ get(); void set(System::Web::UI::WebControls::WebParts::WebPartDisplayMode ^ value); };
[System.ComponentModel.Browsable(false)]
public virtual System.Web.UI.WebControls.WebParts.WebPartDisplayMode DisplayMode { get; set; }
[<System.ComponentModel.Browsable(false)>]
member this.DisplayMode : System.Web.UI.WebControls.WebParts.WebPartDisplayMode with get, set
Public Overridable Property DisplayMode As WebPartDisplayMode

プロパティ値

WebPartDisplayMode

ページの表示モードを決定する WebPartDisplayMode。

属性
BrowsableAttribute

例外

ArgumentNullException

プロパティに割り当てられている WebPartDisplayMode オブジェクトが null です。

ArgumentException

プロパティに割り当てられている WebPartDisplayMode オブジェクトが、サポートされている表示モードではありません。

  • または - プロパティに割り当てられている WebPartDisplayMode オブジェクトが無効です。

例

次のコード例は、プログラムによるプロパティの使用を DisplayMode 示しています。 ブラウザーでページを読み込んだ後、ページの下部付近にあるボタンを使用して表示モードを切り替えることができます。 ページが読み込まれると、ページは既定でブラウズ モードになります。 デザイン モードに切り替えると、サーバー コントロールをあるゾーンから別のゾーンにドラッグしたり、2 つのコントロールを 1 つのゾーン内に配置したりできます。 編集モードに切り替える場合は、いずれかのサーバー コントロールのヘッダーにある動詞メニューをクリックし、[ 編集] を選択し、指定された編集ユーザー インターフェイス (UI) を使用してコントロールを編集できます。

注意

Web パーツ アプリケーションで表示モードを切り替えることは非常に一般的であり、Web パーツ コントロールを含むすべてのページでこれを行うための一貫性のある再利用可能な方法を提供することが必要な場合があります。 表示モードを変更し、多くのページで再利用できるユーザー コントロールの例については、「チュートリアル: Web パーツ ページでの表示モードの変更」を参照してください。

<%@ Page Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
    
  protected void Button1_Click(object sender, EventArgs e)
  {
    mgr.DisplayMode = WebPartManager.BrowseDisplayMode;
  }

  protected void Button2_Click(object sender, EventArgs e)
  {
    mgr.DisplayMode = WebPartManager.DesignDisplayMode;
  }

  protected void Button3_Click(object sender, EventArgs e)
  {
    mgr.DisplayMode = WebPartManager.EditDisplayMode;
  }
  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:WebPartManager ID="mgr" runat="server">
      </asp:WebPartManager>
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <asp:Calendar ID="Calendar1" runat="server" 
            Title="My Calendar" />
        </ZoneTemplate>
      </asp:WebPartZone>
      <asp:WebPartZone ID="WebPartZone2" runat="server">
        <ZoneTemplate>
          <asp:BulletedList 
            DisplayMode="HyperLink" 
            ID="BulletedList1" 
            runat="server"
            Title="My Links">
            <asp:ListItem Value="http://www.microsoft.com">Microsoft</asp:ListItem>
            <asp:ListItem Value="http://www.msn.com">MSN</asp:ListItem>
            <asp:ListItem Value="http://www.contoso.com">Contoso Corp.</asp:ListItem>
          </asp:BulletedList>
        </ZoneTemplate>
      </asp:WebPartZone>
      <asp:EditorZone ID="EditorZone1" runat="server">
        <ZoneTemplate>
          <asp:AppearanceEditorPart runat="server" ID="Appearance1">
          </asp:AppearanceEditorPart>
          <asp:LayoutEditorPart runat="server" ID="Layout1">
          </asp:LayoutEditorPart>
        </ZoneTemplate>
      </asp:EditorZone>
      <hr />
      <asp:Button ID="Button1" runat="server" Text="Browse Mode" OnClick="Button1_Click" />
      <br />
      <asp:Button ID="Button2" runat="server" Text="Design Mode" OnClick="Button2_Click"/>
      <br />
      <asp:Button ID="Button3" runat="server" Text="Edit Mode" OnClick="Button3_Click"/>
    </div>
    </form>
</body>
</html>

<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  
  Protected Sub Button1_Click(ByVal sender As Object, _
    ByVal e As EventArgs)
    mgr.DisplayMode = WebPartManager.BrowseDisplayMode
  End Sub
  
  Protected Sub Button2_Click(ByVal sender As Object, _
    ByVal e As EventArgs)
    mgr.DisplayMode = WebPartManager.DesignDisplayMode
  End Sub
  
  Protected Sub Button3_Click(ByVal sender As Object, _
  ByVal e As EventArgs)
    mgr.DisplayMode = WebPartManager.EditDisplayMode
  End Sub
  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:WebPartManager ID="mgr" runat="server">
      </asp:WebPartManager>
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <asp:Calendar ID="Calendar1" runat="server" 
            Title="My Calendar" />
        </ZoneTemplate>
      </asp:WebPartZone>
      <asp:WebPartZone ID="WebPartZone2" runat="server">
        <ZoneTemplate>
          <asp:BulletedList 
            DisplayMode="HyperLink" 
            ID="BulletedList1" 
            runat="server"
            Title="My Links">
            <asp:ListItem Value="http://www.microsoft.com">Microsoft</asp:ListItem>
            <asp:ListItem Value="http://www.msn.com">MSN</asp:ListItem>
            <asp:ListItem Value="http://www.contoso.com">Contoso Corp.</asp:ListItem>
          </asp:BulletedList>
        </ZoneTemplate>
      </asp:WebPartZone>
      <asp:EditorZone ID="EditorZone1" runat="server">
        <ZoneTemplate>
          <asp:AppearanceEditorPart runat="server" ID="Appearance1">
          </asp:AppearanceEditorPart>
          <asp:LayoutEditorPart runat="server" ID="Layout1">
          </asp:LayoutEditorPart>
        </ZoneTemplate>
      </asp:EditorZone>
      <hr />
      <asp:Button ID="Button1" runat="server" Text="Browse Mode" OnClick="Button1_Click" />
      <br />
      <asp:Button ID="Button2" runat="server" Text="Design Mode" OnClick="Button2_Click"/>
      <br />
      <asp:Button ID="Button3" runat="server" Text="Edit Mode" OnClick="Button3_Click"/>
    </div>
    </form>
</body>
</html>

注釈

Web パーツ コントロールを含むページは、常にいくつかの表示モードの 1 つです。 表示モードの詳細については、「Web パーツページ表示モード」を参照してください。

このクラスは WebPartManager 、Web ページの表示モードを作成します。 基本WebPartDisplayModeクラスを使用して、コントロールは、WebPartManagerWeb パーツ コントロールを含むページで使用できるいくつかの標準表示モード オブジェクトを作成します。 これらの標準表示モードについては、クラスの概要で WebPartDisplayMode 説明します。

コントロールはWebPartManager、Web パーツ コントロールを使用するページの表示モードも管理します。 このプロパティを DisplayMode 使用すると、コントロールは WebPartManager ページ上の現在の表示モードへの参照を保持します。 このプロパティを DisplayMode 使用して、ページを異なる表示モードに切り替えることもできます。 Web パーツ コントロールを使用するページの表示モードを変更する例については、「チュートリアル: Web パーツ ページの表示モードを変更する」を参照してください。

表示モードの管理の一環として、コントロールには、 WebPartManager メソッドやメソッドなどの OnDisplayModeChanged 表示モードに関連するイベントと OnDisplayModeChanging イベント ハンドラーも用意されています。 これらのメソッドは、ページの動作をカスタマイズしたり、カスタム表示モードを追加したりするためのメカニズムを提供します。

適用対象

こちらもご覧ください