DataTableCollection.Item Property (Int32)

 

Gets the DataTable object at the specified index.

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

Public ReadOnly Property Item (
	index As Integer
) As DataTable

Parameters

index
Type: System.Int32

The zero-based index of the DataTable to find.

Property Value

Type: System.Data.DataTable

A DataTablewith the specified index; otherwise null if the DataTable does not exist.

Exception Condition
IndexOutOfRangeException

The index value is greater than the number of items in the collection.

Use the Contains method to determine whether a table with a specific index exists.

If you have the name of a table, but not its index, use the IndexOf method to return the index.

The following example retrieves a DataTable by its index.

Private Sub GetDataTableByIndex()
    ' Presuming a DataGrid is displaying more than one table, get its DataSet.
    Dim thisDataSet As DataSet = CType(DataGrid1.DataSource, DataSet)

    ' Get the DataTableCollection.
    Dim tablesCollection As DataTableCollection = thisDataSet.Tables

    ' Iterate through the collection to get each table name.
    Dim i As Integer
    For i = 0 To tablesCollection.Count - 1
       Console.WriteLine(tablesCollection(i).TableName)
    Next
End Sub

.NET Framework
Available since 1.1
Return to top
Show: