BindingSource.Find Method (PropertyDescriptor, Object)

 

Searches for the index of the item that has the given property descriptor.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

Public Overridable Function Find (
	prop As PropertyDescriptor,
	key As Object
) As Integer

Parameters

prop
Type: System.ComponentModel.PropertyDescriptor

The PropertyDescriptor to search for.

key
Type: System.Object

The value of prop to match.

Return Value

Type: System.Int32

The zero-based index of the item that has the given value for PropertyDescriptor.

Exception Condition
NotSupportedException

The underlying list is not of type IBindingList.

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

This method simply refers the request to the underlying list's IBindingList.Find method. For example, if the underlying data source is a DataSet, DataTable, or DataView, this method calls the DataView.IBindingList.Find method. 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.

The following code example demonstrates how to use the Find method. For the complete example see the class overview topic.

    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

.NET Framework
Available since 2.0
Return to top
Show: