CatalogPartCollection.Contains メソッド

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

CatalogPartCollection.Contains メソッド

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

特定のコントロールがコレクション内に存在するかどうかを示す値を返します。

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

Visual Basic (宣言)

Public Function Contains ( _
    catalogPart As CatalogPart _
) As Boolean

Visual Basic (使用法)

Dim instance As CatalogPartCollection
Dim catalogPart As CatalogPart
Dim returnValue As Boolean

returnValue = instance.Contains(catalogPart)

C#

public bool Contains (
    CatalogPart catalogPart
)

C++

public:
bool Contains (
    CatalogPart^ catalogPart
)

J#

public boolean Contains (
    CatalogPart catalogPart
)

JScript

public function Contains (
    catalogPart : CatalogPart
) : boolean

パラメータ

catalogPart

コレクション内に存在するかどうかの確認の対象となる CatalogPart。

戻り値
特定のコントロールがコレクション内に存在するかどうかを示すブール値。

解説

特定の CatalogPart オブジェクトが CatalogPartCollection オブジェクトの一部であるかどうかを、Contains メソッドを使って確認できます。

使用例

特定の CatalogPart コントロールが CatalogPartCollection オブジェクトのメンバかどうかを確認する方法を次のコード例に示します。例の実行に必要なコード全体については、CatalogPartCollection クラスの概要のトピックで「例」を参照してください。

Button1_Click メソッド内のコードは、myParts という名前の新しい CatalogPartCollection オブジェクトを作成します。このメソッドは Contains メソッドを使用して PageCatalogPart1 コントロールが存在するかどうかを確認し、存在していれば、そのコントロールを取得してプロパティ値を変更します。

Visual Basic

Protected Sub Button1_Click(ByVal
 sender As Object, ByVal
 e As EventArgs) 
    Dim list As New ArrayList(2)
    list.Add(PageCatalogPart1)
    list.Add(DeclarativeCatalogPart1)
    ' Pass an ICollection object to the constructor.
    Dim myParts As New CatalogPartCollection(list)
    Dim catalog As CatalogPart
    For Each catalog In
  myParts
        catalog.Description = "My " + catalog.DisplayTitle
    Next catalog
    
    ' Use the IndexOf property to locate a CatalogPart control.
    Dim PageCatalogPartIndex As Integer
 = _
      myParts.IndexOf(PageCatalogPart1)
    myParts(PageCatalogPartIndex).ChromeType = PartChromeType.TitleOnly
    
    ' Use the Contains method to see if a CatalogPart control exists.
    If myParts.Contains(PageCatalogPart1) Then
        Dim closedWebPart As WebPart = Nothing
        Dim descriptions As WebPartDescriptionCollection
 = _
          PageCatalogPart1.GetAvailableWebPartDescriptions()
        If descriptions.Count > 0 Then
            closedWebPart = PageCatalogPart1.GetWebPart(descriptions(0))
            closedWebPart.AllowClose = False
        End If
    End If
    
    ' Use indexers to display the details of the CatalogPart controls.
    Label1.Text = String.Empty
    Label1.Text = _
      "<h3>PageCatalogPart Details</h3>"
 & _
      "ID: " & myParts(0).ID + "<br
 />" & _
      "Count: " & myParts(0).GetAvailableWebPartDescriptions().Count
    Label1.Text += _
      "<h3>DeclarativeCatalogPart Details</h3>"
 & _
      "ID: " & myParts("DeclarativeCatalogPart1").ID
 & "<br />" & _
      "Count: " & myParts("DeclarativeCatalogPart1")
 _
        .GetAvailableWebPartDescriptions().Count

End Sub 

C#

protected void Button1_Click(object sender,
 EventArgs e)
{
  ArrayList list = new ArrayList(2);
  list.Add(PageCatalogPart1);
  list.Add(DeclarativeCatalogPart1);
  // Pass an ICollection object to the constructor.
  CatalogPartCollection myParts = new CatalogPartCollection(list);
  foreach (CatalogPart catalog in myParts)
  {
    catalog.Description = "My " + catalog.DisplayTitle;
  }

  // Use the IndexOf property to locate a CatalogPart control.
  int PageCatalogPartIndex = myParts.IndexOf(PageCatalogPart1);
  myParts[PageCatalogPartIndex].ChromeType = PartChromeType.TitleOnly;

  // Use the Contains method to see if a CatalogPart control exists.
  if (myParts.Contains(PageCatalogPart1))
  {
    WebPart closedWebPart = null;
    WebPartDescriptionCollection descriptions = PageCatalogPart1.GetAvailableWebPartDescriptions();
    if (descriptions.Count > 0)
    {
      closedWebPart = PageCatalogPart1.GetWebPart(descriptions[0]);
      closedWebPart.AllowClose = false;
    }
  }
  
  // Use indexers to display the details of the CatalogPart controls.
  Label1.Text = String.Empty;
  Label1.Text =
    "<h3>PageCatalogPart Details</h3>" +
    "ID: " + myParts[0].ID + "<br />" +
    "Count: " + myParts[0].GetAvailableWebPartDescriptions().Count;
  Label1.Text += 
    "<h3>DeclarativeCatalogPart Details</h3>" +
    "ID: " + myParts["DeclarativeCatalogPart1"].ID + "<br
 />" +
    "Count: " + myParts["DeclarativeCatalogPart1"].GetAvailableWebPartDescriptions().Count;
}

ブラウザでページを読み込む場合、[Display Mode] ドロップダウン リスト コントロールで [カタログ] を選択することにより、ページをカタログ モードに切り替えることができます。カスタム WebPart コントロールの横のチェック ボックスをオンにし、[追加] をクリックしてそのコントロールをページに追加します。[閉じる] をクリックしてページをブラウズ モードに戻します。追加したコントロールで、動詞メニュー (タイトル バーに表示される下向きの矢印) をクリックして [閉じる] をクリックすると、そのコントロールがページから削除されて PageCatalogPart コントロールに追加されます。ページをカタログ モードに戻し、[ページ カタログ] リンクをクリックして PageCatalogPart コントロールの内容を表示します。先ほど閉じられたコントロールが追加されています。[Display CatalogPart Properties] をクリックすると、CatalogPartCollection オブジェクトにアクセスします。さらに、格納されている CatalogPart コントロールの特定のプロパティが表示されます。PageCatalogPart コントロールに格納されたサーバー コントロールの横のチェック ボックスをオンにし、[追加] をクリックしてそのコントロールをもう一度ページに戻します。次に [閉じる] をクリックしてページをブラウズ モードに戻します。コントロールの動詞メニューを再度クリックして、Close 動詞が消えたことを確認します。Contains メソッドを使用して PageCatalogPart1 を確認した際に、このコントロールは Button1_Click メソッドのコードによって削除されました。次にこのコントロールの AllowClose プロパティを false に設定します。

プラットフォーム

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

参照

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