This topic has not yet been rated - Rate this topic

DataTableCollection Class

Represents the collection of tables for the DataSet.

System.Object
  System.Data.InternalDataCollectionBase
    System.Data.DataTableCollection

Namespace:  System.Data
Assembly:  System.Data (in System.Data.dll)
[ListBindableAttribute(false)]
public sealed class DataTableCollection : InternalDataCollectionBase

The DataTableCollection type exposes the following members.

  Name Description
Public property Supported by the XNA Framework Count Gets the total number of elements in a collection. (Inherited from InternalDataCollectionBase.)
Public property Supported by the XNA Framework IsReadOnly Gets a value that indicates whether the InternalDataCollectionBase is read-only. (Inherited from InternalDataCollectionBase.)
Public property Supported by the XNA Framework IsSynchronized Gets a value that indicates whether the InternalDataCollectionBase is synchonized. (Inherited from InternalDataCollectionBase.)
Public property Supported by the XNA Framework Item[Int32] Gets the DataTable object at the specified index.
Public property Supported by the XNA Framework Item[String] Gets the DataTable object with the specified name.
Public property Supported by the XNA Framework Item[String, String] Gets the DataTable object with the specified name in the specified namespace.
Protected property Supported by the XNA Framework List Gets the items of the collection as a list. (Inherited from InternalDataCollectionBase.)
Public property Supported by the XNA Framework SyncRoot Gets an object that can be used to synchronize the collection. (Inherited from InternalDataCollectionBase.)
Top
  Name Description
Public method Supported by the XNA Framework Add() Creates a new DataTable object by using a default name and adds it to the collection.
Public method Supported by the XNA Framework Add(DataTable) Adds the specified DataTable to the collection.
Public method Supported by the XNA Framework Add(String) Creates a DataTable object by using the specified name and adds it to the collection.
Public method Supported by the XNA Framework Add(String, String) Creates a DataTable object by using the specified name and adds it to the collection.
Public method Supported by the XNA Framework AddRange Copies the elements of the specified DataTable array to the end of the collection.
Public method Supported by the XNA Framework CanRemove Verifies whether the specified DataTable object can be removed from the collection.
Public method Supported by the XNA Framework Clear Clears the collection of all DataTable objects.
Public method Supported by the XNA Framework Contains(String) Gets a value that indicates whether a DataTable object with the specified name exists in the collection.
Public method Supported by the XNA Framework Contains(String, String) Gets a value that indicates whether a DataTable object with the specified name and table namespace exists in the collection.
Public method Supported by the XNA Framework CopyTo(Array, Int32) Copies all the elements of the current InternalDataCollectionBase to a one-dimensional Array, starting at the specified InternalDataCollectionBase index. (Inherited from InternalDataCollectionBase.)
Public method Supported by the XNA Framework CopyTo(DataTable[], Int32) Copies all the elements of the current DataTableCollection to a one-dimensional Array, starting at the specified destination array index.
Public method Supported by the XNA Framework Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Supported by the XNA Framework Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by the XNA Framework GetEnumerator Gets an IEnumerator for the collection. (Inherited from InternalDataCollectionBase.)
Public method Supported by the XNA Framework GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method Supported by the XNA Framework GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Supported by the XNA Framework IndexOf(DataTable) Gets the index of the specified DataTable object.
Public method Supported by the XNA Framework IndexOf(String) Gets the index in the collection of the DataTable object with the specified name.
Public method Supported by the XNA Framework IndexOf(String, String) Gets the index in the collection of the specified DataTable object.
Protected method Supported by the XNA Framework MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Supported by the XNA Framework Remove(DataTable) Removes the specified DataTable object from the collection.
Public method Supported by the XNA Framework Remove(String) Removes the DataTable object with the specified name from the collection.
Public method Supported by the XNA Framework Remove(String, String) Removes the DataTable object with the specified name from the collection.
Public method Supported by the XNA Framework RemoveAt Removes the DataTable object at the specified index from the collection.
Public method Supported by the XNA Framework ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public event Supported by the XNA Framework CollectionChanged Occurs after the DataTableCollection is changed because of DataTable objects being added or removed.
Public event Supported by the XNA Framework CollectionChanging Occurs while the DataTableCollection is changing because of DataTable objects being added or removed.
Top

The DataTableCollection contains all the DataTable objects for a particular DataSet. To access the DataTableCollection of a DataSet, use the Tables property.

The DataTableCollection uses methods such as Add, Clear, and Remove to manage the items in the collection.

Use the Contains method to determine whether a particular table (specified by either index or name) is in the collection.

To navigate from one table to another, use the ChildRelations or ParentRelations property of the DataTable to access its collection of DataRelation objects. You can also use the Relations property to navigate through the parent/child relationships of the DataTables in a particular DataSet collection.

The first procedure in this example retrieves the DataTableCollection of a DataSet and prints the value of each column, in each row, of each table. The second procedure creates a new DataTable with two columns, and adds it to the DataTableCollection.


private void GetTables(DataSet dataSet)
{
    // Get Each DataTable in the DataTableCollection and 
    // print each row value.
    foreach (DataTable table in dataSet.Tables)
        foreach (DataRow row in table.Rows)
            foreach (DataColumn column in table.Columns)
                if (row[column] != null)
                    Console.WriteLine(row[column]);
}

private void CreateTable(DataSet dataSet)
{
    DataTable newTable = new DataTable("table");
    newTable.Columns.Add("ID", typeof(int));
    newTable.Columns.Add("Name", typeof(string));
    dataSet.Tables.Add(newTable);
}


.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.

This type is safe for multithreaded read operations. You must synchronize any write operations.

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ