Collection.Contains

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

Collection.Contains メソッド

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

Visual Basic の Collection オブジェクトに特定のキーを持つ要素が含まれているかどうかを示す Boolean 値を返します。

名前空間: Microsoft.VisualBasic
アセンブリ: Microsoft.VisualBasic (microsoft.visualbasic.dll 内)
構文

Visual Basic (宣言)

Public Function Contains ( _
    Key As String _
) As Boolean

Visual Basic (使用法)

Dim instance As Collection
Dim Key As String
Dim returnValue As Boolean

returnValue = instance.Contains(Key)

C#

public bool Contains (
    string Key
)

C++

public:
bool Contains (
    String^ Key
)

J#

public boolean Contains (
    String Key
)

JScript

public function Contains (
    Key : String
) : boolean

パラメータ

Key

必須。コレクションの要素を検索するキーを指定する String 型の式。

戻り値
Visual Basic の Collection オブジェクトに特定のキーを持つ要素が含まれているかどうかを示す Boolean 値を返します。

解説

詳細については、Visual Basic のトピック「Contains メソッド (Collection オブジェクト)」を参照してください。

Key に完全に一致するキーを持つ要素がコレクションに含まれている場合、Contains は True を返します。それ以外の場合は、Contains は False を返します。

Visual Basic の Collection が保持する要素には、キーを持つ要素とキーを持たない要素があります。これは、Add メソッド (Collection オブジェクト) の呼び出しが、オプションの Key パラメータに引数を提供するかどうかによって異なります。

使用例

Visual Basic

Dim customers As New Microsoft.VisualBasic.Collection()
Dim accountNumber As String
 = "1234"
' Insert code that obtains new customer objects.
' Use the new customer's account number as the key.
customers.Add(newCustomer, accountNumber)
' The preceding statements can be repeated for several customers.
Dim searchNumber As String
 = "1234"
' Insert code to obtain an account number to search for.
If customers.Contains(searchNumber) Then
    MsgBox("The desired customer is in the collection.")
Else
    MsgBox("The desired customer is not in the collection.")
End If

コレクションでキーを使って要素を検索する場合は、Add メソッドを呼び出すたびに、必ず Key 引数を指定してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
Collection クラス
Collection メンバ
Microsoft.VisualBasic 名前空間
その他の技術情報
Contains メソッド (Collection オブジェクト)
Collection オブジェクト (Visual Basic)
Item プロパティ (Collection オブジェクト)
Count プロパティ (Collection オブジェクト)
Add メソッド (Collection オブジェクト)
Remove メソッド (Collection オブジェクト)
Clear メソッド (Collection オブジェクト)

Collection.Contains メソッド

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

ある要素が Collection 内に存在するかどうかを判断します。

名前空間: System.Collections.ObjectModel
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public Function Contains ( _
    item As T _
) As Boolean

Visual Basic (使用法)

Dim instance As Collection(Of
 T)
Dim item As T
Dim returnValue As Boolean

returnValue = instance.Contains(item)

C#

public bool Contains (
    T item
)

C++

public:
virtual bool Contains (
    T item
) sealed

J#

public final boolean Contains (
    T item
)

JScript

public final function Contains (
    item : T
) : boolean

パラメータ

item

Collection 内で検索するオブジェクト。参照型の場合、null 参照 (Visual Basic では Nothing) の値を使用できます。

戻り値
item が Collection に存在する場合は true。それ以外の場合は false。

解説

このメソッドは、既定の比較演算子 Comparer.Default を使用して、等しいかどうかを確認します。Comparer.Default は、型 T が System.IComparable を実装しているかどうかをチェックし、利用可能な場合はその実装を使用します。そうでない場合、Comparer.Default は、型 T が System.IComparable を実装しているかどうかをチェックします。T がいずれのインターフェイスも実装しない場合、このメソッドは System.Object.Equals を使用します。

このメソッドは順次検索を実行します。したがって、平均検索時間は Count に比例します。つまり、このメソッドは O(n) 操作です。ここで、n は Count です。

使用例

Collection が備える多数のプロパティとメソッドを使用した例を次に示します。このコード例では、文字列のコレクションを作成し、Add メソッドを使用していくつかの文字列を追加し、Count を表示して、文字列を一覧表示します。IndexOf メソッドを使用して文字列のインデックスを検索し、Contains メソッドを使用して文字列がコレクションにあるかどうかを判断します。Insert メソッドを使用して文字列を挿入し、既定の Item プロパティ (C# の場合はインデクサ) を使用して文字列を取得および設定します。文字列 ID による文字列の削除のために Remove メソッドを使用し、インデックスによる文字列の削除のために RemoveAt メソッドを使用します。最後に、Clear メソッドを使用してコレクションのすべての文字列をクリアします。

Visual Basic

Imports System
Imports System.Collections.Generic
Imports System.Collections.ObjectModel

Public Class Demo
    
    Public Shared Sub Main()
 

        Dim dinosaurs As New
 Collection(Of String)

        dinosaurs.Add("Psitticosaurus")
        dinosaurs.Add("Caudipteryx")
        dinosaurs.Add("Compsognathus")
        dinosaurs.Add("Muttaburrasaurus")

        Console.WriteLine("{0} dinosaurs:", dinosaurs.Count)
        Display(dinosaurs)
    
        Console.WriteLine(vbLf & "IndexOf(""Muttaburrasaurus""):
 {0}", _
            dinosaurs.IndexOf("Muttaburrasaurus"))

        Console.WriteLine(vbLf & "Contains(""Caudipteryx""):
 {0}", _
            dinosaurs.Contains("Caudipteryx"))

        Console.WriteLine(vbLf & "Insert(2, ""Nanotyrannus"")")
        dinosaurs.Insert(2, "Nanotyrannus")
        Display(dinosaurs)

        Console.WriteLine(vbLf & "dinosaurs(2): {0}",
 dinosaurs(2))

        Console.WriteLine(vbLf & "dinosaurs(2) = ""Microraptor""")
        dinosaurs(2) = "Microraptor"
        Display(dinosaurs)

        Console.WriteLine(vbLf & "Remove(""Microraptor"")")
        dinosaurs.Remove("Microraptor")
        Display(dinosaurs)

        Console.WriteLine(vbLf & "RemoveAt(0)")
        dinosaurs.RemoveAt(0)
        Display(dinosaurs)
 
        Console.WriteLine(vbLf & "dinosaurs.Clear()")
        dinosaurs.Clear()
        Console.WriteLine("Count: {0}", dinosaurs.Count)

    End Sub
    
    Private Shared Sub Display(ByVal
 cs As Collection(Of String))
 
        Console.WriteLine()
        For Each item As
 String In cs
            Console.WriteLine(item)
        Next item
    End Sub
End Class

' This code example produces the following output:
'
'4 dinosaurs:
'
'Psitticosaurus
'Caudipteryx
'Compsognathus
'Muttaburrasaurus
'
'IndexOf("Muttaburrasaurus"): 3
'
'Contains("Caudipteryx"): True
'
'Insert(2, "Nanotyrannus")
'
'Psitticosaurus
'Caudipteryx
'Nanotyrannus
'Compsognathus
'Muttaburrasaurus
'
'dinosaurs(2): Nanotyrannus
'
'dinosaurs(2) = "Microraptor"
'
'Psitticosaurus
'Caudipteryx
'Microraptor
'Compsognathus
'Muttaburrasaurus
'
'Remove("Microraptor")
'
'Psitticosaurus
'Caudipteryx
'Compsognathus
'Muttaburrasaurus
'
'RemoveAt(0)
'
'Caudipteryx
'Compsognathus
'Muttaburrasaurus
'
'dinosaurs.Clear()
'Count: 0

C#

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;

public class Demo
{
    public static void Main()
    {
        Collection<string> dinosaurs = new
 Collection<string>();

        dinosaurs.Add("Psitticosaurus");
        dinosaurs.Add("Caudipteryx");
        dinosaurs.Add("Compsognathus");
        dinosaurs.Add("Muttaburrasaurus");

        Console.WriteLine("{0} dinosaurs:", dinosaurs.Count);
        Display(dinosaurs);
    
        Console.WriteLine("\nIndexOf(\"Muttaburrasaurus\"): {0}",
 
            dinosaurs.IndexOf("Muttaburrasaurus"));

        Console.WriteLine("\nContains(\"Caudipteryx\"): {0}",
 
            dinosaurs.Contains("Caudipteryx"));

        Console.WriteLine("\nInsert(2, \"Nanotyrannus\")");
        dinosaurs.Insert(2, "Nanotyrannus");
        Display(dinosaurs);

        Console.WriteLine("\ndinosaurs[2]: {0}", dinosaurs[2]);

        Console.WriteLine("\ndinosaurs[2] = \"Microraptor\"");
        dinosaurs[2] = "Microraptor";
        Display(dinosaurs);

        Console.WriteLine("\nRemove(\"Microraptor\")");
        dinosaurs.Remove("Microraptor");
        Display(dinosaurs);

        Console.WriteLine("\nRemoveAt(0)");
        dinosaurs.RemoveAt(0);
        Display(dinosaurs);

        Console.WriteLine("\ndinosaurs.Clear()");
        dinosaurs.Clear();
        Console.WriteLine("Count: {0}", dinosaurs.Count);
    }
    
    private static void
 Display(Collection<string> cs)
    {
        Console.WriteLine();
        foreach( string item in
 cs )
        {
            Console.WriteLine(item);
        }
    }
}

/* This code example produces the following output:

4 dinosaurs:

Psitticosaurus
Caudipteryx
Compsognathus
Muttaburrasaurus

IndexOf("Muttaburrasaurus"): 3

Contains("Caudipteryx"): True

Insert(2, "Nanotyrannus")

Psitticosaurus
Caudipteryx
Nanotyrannus
Compsognathus
Muttaburrasaurus

dinosaurs[2]: Nanotyrannus

dinosaurs[2] = "Microraptor"

Psitticosaurus
Caudipteryx
Microraptor
Compsognathus
Muttaburrasaurus

Remove("Microraptor")

Psitticosaurus
Caudipteryx
Compsognathus
Muttaburrasaurus

RemoveAt(0)

Caudipteryx
Compsognathus
Muttaburrasaurus

dinosaurs.Clear()
Count: 0
 */

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
Collection ジェネリック クラス
Collection メンバ
System.Collections.ObjectModel 名前空間
IndexOf
その他の技術情報
カルチャを認識しないコレクションの操作の実行