BindingSource.Find BindingSource.Find BindingSource.Find BindingSource.Find Method

定義

データ ソースから指定された項目を検索します。Find the specified item in the data source.

オーバーロード

Find(PropertyDescriptor, Object) Find(PropertyDescriptor, Object) Find(PropertyDescriptor, Object) Find(PropertyDescriptor, Object)

指定したプロパティ記述子を持つ項目のインデックスを検索します。Searches for the index of the item that has the given property descriptor.

Find(String, Object) Find(String, Object) Find(String, Object) Find(String, Object)

指定した名前のプロパティと値を持つリスト内の項目のインデックスを返します。Returns the index of the item in the list with the specified property name and value.

Find(PropertyDescriptor, Object) Find(PropertyDescriptor, Object) Find(PropertyDescriptor, Object) Find(PropertyDescriptor, Object)

指定したプロパティ記述子を持つ項目のインデックスを検索します。Searches for the index of the item that has the given property descriptor.

public:
 virtual int Find(System::ComponentModel::PropertyDescriptor ^ prop, System::Object ^ key);
public virtual int Find (System.ComponentModel.PropertyDescriptor prop, object key);
abstract member Find : System.ComponentModel.PropertyDescriptor * obj -> int
override this.Find : System.ComponentModel.PropertyDescriptor * obj -> int
Public Overridable Function Find (prop As PropertyDescriptor, key As Object) As Integer

パラメーター

key
Object Object Object Object

検索条件として使用する prop の値。The value of prop to match.

戻り値

PropertyDescriptor の指定した値を持つ項目の 0 から始まるインデックス。The zero-based index of the item that has the given value for PropertyDescriptor.

実装

例外

基底のリストが IBindingList 型ではありません。The underlying list is not of type IBindingList.

次のコード例は、Find メソッドの使用方法を示します。The following code example demonstrates how to use the Find method. 完全な例については、クラスの概要に関するトピックを参照してください。For the complete example see the class overview topic.

private void button1_Click(object sender, EventArgs e)
{
    if (binding1.SupportsSearching != true)
        MessageBox.Show("Cannot search the list.");
    else
    {
        int foundIndex = binding1.Find("Name", textBox1.Text);
        if (foundIndex > -1)
            listBox1.SelectedIndex = foundIndex;
        else
            MessageBox.Show("Font was not found.");
    }
}
    Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs) _
        Handles button1.Click

        If binding1.SupportsSearching <> True Then
            MessageBox.Show("Cannot search the list.")
        Else
            Dim foundIndex As Integer = binding1.Find("Name", textBox1.Text)
            If foundIndex > -1 Then
                listBox1.SelectedIndex = foundIndex
            Else
                MessageBox.Show("Font was not found.")
            End If
        End If

    End Sub
End Class

注釈

通常、このメソッドは、 propパラメーターで指定されたフィールドの値がkeyパラメーターの値と等しい最初の行を検索するために、複雑なデータバインディングケースで使用されます。This method is typically used in complex data-binding cases to locate the first row where the value of the field specified by the prop parameter equals the value of the key parameter

このメソッドは、要求を基になるリストのIBindingList.Findメソッドに単に参照します。This method simply refers the request to the underlying list's IBindingList.Find method. たとえば、基になるデータソースDataSetが、 DataTable、またはDataViewの場合、このメソッドはDataView.IBindingList.Findメソッドを呼び出します。For example, if the underlying data source is a DataSet, DataTable, or DataView, this method calls the DataView.IBindingList.Find method. 一致する項目IBindingList.Findが見つからない場合に返される値など、の動作は、基になるリストのメソッドの実装によって異なります。The behavior of IBindingList.Find, such as the value returned if no matching item is found, depends on the implementation of the method in the underlying list.

こちらもご覧ください

Find(String, Object) Find(String, Object) Find(String, Object) Find(String, Object)

指定した名前のプロパティと値を持つリスト内の項目のインデックスを返します。Returns the index of the item in the list with the specified property name and value.

public:
 int Find(System::String ^ propertyName, System::Object ^ key);
public int Find (string propertyName, object key);
member this.Find : string * obj -> int
Public Function Find (propertyName As String, key As Object) As Integer

パラメーター

propertyName
String String String String

検索するプロパティの名前。The name of the property to search for.

key
Object Object Object Object

検索の対象となる指定した propertyName を持つ項目の値。The value of the item with the specified propertyName to find.

戻り値

指定した名前のプロパティと値を持つ項目の 0 から始まるインデックス。The zero-based index of the item with the specified property name and value.

例外

基底のリストが、検索機能を実装した IBindingList ではありません。The underlying list is not a IBindingList with searching functionality implemented.

propertyName がリスト内のプロパティと一致しません。propertyName does not match a property in the list.

次の例は、 Find DataViewでメソッドを使用する方法を示しています。The following example shows how to use the Find method with a DataView. この例を実行するには、Windows フォームにコードを貼りPopulateDataViewAndFind付け、フォームのコンストラクターまたLoadはイベント処理メソッドからを呼び出します。To run this example, paste the code into a Windows Form and call PopulateDataViewAndFind from the form's constructor or Load event-handling method. フォームで名前空間System.XmlSystem.IO名前空間をインポートする必要があります。Your form should import the System.Xml and System.IO namespaces.

private void PopulateDataViewAndFind()
{
    DataSet set1 = new DataSet();

    // Some xml data to populate the DataSet with.
    string musicXml =
        "<?xml version='1.0' encoding='UTF-8'?>" +
        "<music>" +
        "<recording><artist>Coldplay</artist><cd>X&amp;Y</cd></recording>" +
        "<recording><artist>Dave Matthews</artist><cd>Under the Table and Dreaming</cd></recording>" +
        "<recording><artist>Natalie Merchant</artist><cd>Tigerlily</cd></recording>" +
        "<recording><artist>U2</artist><cd>How to Dismantle an Atomic Bomb</cd></recording>" +
        "</music>";

    // Read the xml.
    StringReader reader = new StringReader(musicXml);
    set1.ReadXml(reader);

    // Get a DataView of the table contained in the dataset.
    DataTableCollection tables = set1.Tables;
    DataView view1 = new DataView(tables[0]);

    // Create a DataGridView control and add it to the form.
    DataGridView datagridview1 = new DataGridView();
    datagridview1.AutoGenerateColumns = true;
    this.Controls.Add(datagridview1);

    // Create a BindingSource and set its DataSource property to
    // the DataView.
    BindingSource source1 = new BindingSource();
    source1.DataSource = view1;

    // Set the data source for the DataGridView.
    datagridview1.DataSource = source1;

    // Set the Position property to the results of the Find method.
    int itemFound = source1.Find("artist", "Natalie Merchant");
    source1.Position = itemFound;
}
Private Sub PopulateDataViewAndFind() 
    Dim set1 As New DataSet()
    
    ' Some xml data to populate the DataSet with.
    Dim musicXml As String = "<?xml version='1.0' encoding='UTF-8'?>" & _
        "<music>" & _
        "<recording><artist>Coldplay</artist><cd>X&amp;Y</cd></recording>" & _
        "<recording><artist>Dave Matthews</artist><cd>Under the Table and Dreaming</cd></recording>" & _
        "<recording><artist>Natalie Merchant</artist><cd>Tigerlily</cd></recording>" & _
        "<recording><artist>U2</artist><cd>How to Dismantle an Atomic Bomb</cd></recording>" & _
        "</music>"
    
    ' Read the xml.
    Dim reader As New StringReader(musicXml)
    set1.ReadXml(reader)
    
    ' Get a DataView of the table contained in the dataset.
    Dim tables As DataTableCollection = set1.Tables
    Dim view1 As New DataView(tables(0))
    
    ' Create a DataGridView control and add it to the form.
    Dim datagridview1 As New DataGridView()
    datagridview1.AutoGenerateColumns = True
    Me.Controls.Add(datagridview1)
    
    ' Create a BindingSource and set its DataSource property to
    ' the DataView.
    Dim source1 As New BindingSource()
    source1.DataSource = view1
    
    ' Set the data source for the DataGridView.
    datagridview1.DataSource = source1
    
    ' Set the Position property to the results of the Find method.
    Dim itemFound As Integer = source1.Find("artist", "Natalie Merchant")
    source1.Position = itemFound

End Sub

注釈

メソッドは、基になるリストIBindingListが検索を実装したである場合にのみ使用できます。 FindThe Find method can only be used when the underlying list is an IBindingList with searching implemented. このメソッドは、要求を基になるリストのIBindingList.Findメソッドに単に参照します。This method simply refers the request to the underlying list's IBindingList.Find method. たとえば、基になるデータソースがDataSetDataTable、またはDataViewの場合、 IBindingList.FindこのメソッドpropertyNameはをPropertyDescriptorに変換し、メソッドを呼び出します。For example, if the underlying data source is a DataSet, DataTable, or DataView, this method converts propertyName to a PropertyDescriptor and calls the IBindingList.Find method. 一致する項目Findが見つからない場合に返される値など、の動作は、基になるリストのメソッドの実装によって異なります。The behavior of Find, such as the value returned if no matching item is found, depends on the implementation of the method in the underlying list.

プロパティ名の比較では、大文字と小文字は区別されません。The property name comparison is case-insensitive.

適用対象