This documentation is archived and is not being maintained.

DataTableCollection.IndexOf Method (String)

Gets the index in the collection of the DataTable object with the specified name.

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

public int IndexOf(
	string tableName
)

Parameters

tableName
Type: System.String
The name of the DataTable object to look for.

Return Value

Type: System.Int32
The zero-based index of the DataTable with the specified name, or -1 if the table does not exist in the collection.
NoteNote

Returns -1 when two or more tables have the same name but different namespaces. The call does not succeed if there is any ambiguity when matching a table name to exactly one table.

You specify the name of the DataTable object by using the TableName property.

The following example returns the index of a named table in the DataTableCollection.


private void GetIndexes()
{
    // Get the DataSet of a DataGrid.
    DataSet thisDataSet = (DataSet)DataGrid1.DataSource;

    // Get the DataTableCollection through the Tables property.
    DataTableCollection tables = thisDataSet.Tables;

    // Get the index of the table named "Authors", if it exists.
    if (tables.Contains("Authors"))
        System.Diagnostics.Debug.WriteLine(tables.IndexOf("Authors"));
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: