DataRowCollection.Contains Method (Object)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets a value that indicates whether the primary key of any row in the collection contains the specified value.

Namespace:   System.Data
Assembly:  System.Data (in System.Data.dll)

public bool Contains(
	object key
)

Parameters

key
Type: System.Object

The value of the primary key to test for.

Return Value

Type: System.Boolean

true if the collection contains a DataRow with the specified primary key value; otherwise, false.

Exception Condition
MissingPrimaryKeyException

The table does not have a primary key.

To use the Contains method, the DataTable object to which the DataRowCollection object belongs to must have at least one column designated as a primary key column. See the PrimaryKey property for more information about how to create a primary key column.

As soon as you have determined that a row contains the specified value, you can use the Find method to return the specific DataRow object that has the value.

The following Visual Basic example uses the Contains method to determine whether a DataRowCollection object contains a specific value.

 Private Sub ColContains()
    Dim table As DataTable = CType(DataGrid1.DataSource, DataTable)
    Dim rowCollection As DataRowCollection = table.Rows
    If rowCollection.Contains(Edit1.Text) Then
       Label1.Text = "At least one row contains " & Edit1.Text 
    Else
       Label1.Text = "No row contains the value in its primary key field"
    End If
End Sub

.NET Framework
Available since 1.1
Return to top
Show: