WebPartDisplayModeCollection.Add メソッド

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

WebPartDisplayModeCollection.Add メソッド

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

WebPartDisplayMode オブジェクトをコレクションに追加します。

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

Visual Basic (宣言)

Public Function Add ( _
    value As WebPartDisplayMode _
) As Integer

Visual Basic (使用法)

Dim instance As WebPartDisplayModeCollection
Dim value As WebPartDisplayMode
Dim returnValue As Integer

returnValue = instance.Add(value)

C#

public int Add (
    WebPartDisplayMode value
)

C++

public:
int Add (
    WebPartDisplayMode^ value
)

J#

public int Add (
    WebPartDisplayMode value
)

JScript

public function Add (
    value : WebPartDisplayMode
) : int

パラメータ

value

コレクションに追加する WebPartDisplayMode。

戻り値
コレクション内での WebPartDisplayMode の挿入位置を示す整数値。

解説

Add メソッドを使用すると、新しい WebPartDisplayMode オブジェクトを既存の WebPartDisplayModeCollection オブジェクトに追加できます。

これを行う場合としては、WebPartDisplayMode カスタム クラスを作成して、ページでサポートされている表示モードのコレクションにこれを追加する場合などがあります。そのためには、WebPartManager クラスから継承し、その CreateDisplayModes メソッドをオーバーライドし、基本メソッドを呼び出してから、Add メソッドを使用してカスタム表示モードをコレクションに追加する必要があります。

使用例

WebPartDisplayModeCollection クラスの使用方法を示すコード例を次に示します。例の実行に必要なコード全体については、WebPartDisplayModeCollection クラスの概要の「例」を参照してください。

コードの次の部分は、CreateDisplayModes メソッドをオーバーライドし、カスタム表示モードをコレクションに追加する WebPartManager 派生クラスで発生します。

Visual Basic

Imports System
Imports System.Collections.Generic
Imports System.Configuration
Imports System.Web
Imports System.Web.Security
Imports System.Security.Permissions
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts

Namespace Samples.AspNet.VB.Controls

  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class NewWebPartManager
    Inherits WebPartManager
    Private Shared _inLineEditDisplayMode As
 WebPartDisplayMode = _
      New InlineWebPartEditDisplayMode()

    Public Sub New()
    End Sub

    Protected Overrides Function
 CreateDisplayModes() As WebPartDisplayModeCollection
      Dim displayModes As WebPartDisplayModeCollection
 = MyBase.CreateDisplayModes()
      displayModes.Add(_inLineEditDisplayMode)
      Return displayModes

    End Function 

    Public ReadOnly Property
 InLineEditDisplayMode() As WebPartDisplayMode
        Get
            Return _inLineEditDisplayMode
        End Get
    End Property

    Private NotInheritable Class
 InlineWebPartEditDisplayMode
      Inherits WebPartDisplayMode

      Public Sub New()
        MyBase.New("Inline Edit Display")
      End Sub

      Public Overrides ReadOnly
 Property AllowPageDesign() As Boolean
        Get
          Return True
        End Get
      End Property

      Public Overrides ReadOnly
 Property RequiresPersonalization() _
        As Boolean
        Get
          Return True
        End Get
      End Property

      Public Overrides ReadOnly
 Property ShowHiddenWebParts() As Boolean
        Get
          Return False
        End Get
      End Property

      Public Overrides ReadOnly
 Property AssociatedWithToolZone() _
        As Boolean
        Get
          Return False
        End Get
      End Property

      Public Overrides Function
 IsEnabled(ByVal webPartManager _
        As WebPartManager) As Boolean

        Return True

      End Function

    End Class

  End Class

End Namespace

C#

using System;
using System.Collections.Generic;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Security.Permissions;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;

namespace Samples.AspNet.CS.Controls
{
  [AspNetHostingPermission(SecurityAction.Demand,
  Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class NewWebPartManager : WebPartManager
 
  {
    private static readonly WebPartDisplayMode
 _inLineEditDisplayMode =
      new InlineWebPartEditDisplayMode();

    public NewWebPartManager() {}

    protected override WebPartDisplayModeCollection CreateDisplayModes()
 
    {
      WebPartDisplayModeCollection displayModes = 
        base.CreateDisplayModes();
      displayModes.Add(_inLineEditDisplayMode);
      return displayModes;
    }

    public WebPartDisplayMode InLineEditDisplayMode
    {
      get { return _inLineEditDisplayMode;
 }
    }

    private sealed class InlineWebPartEditDisplayMode
 : WebPartDisplayMode
    {
      public InlineWebPartEditDisplayMode()
        : base("Inline Edit Display")
      {
      }
      public override bool AllowPageDesign
      {
        get { return true;
 }
      }
      public override bool RequiresPersonalization
      {
        get { return true;
 }
      }
      public override bool ShowHiddenWebParts
      {
        get { return false;
 }
      }
      public override bool AssociatedWithToolZone
      {
        get { return false;
 }
      }
      public override bool IsEnabled(WebPartManager
 webPartManager)
      {
        return true;
      }
    }

  }

}

プラットフォーム

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

参照

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