ITableMappingCollection Interface

Definition

Namespace:

System.Data

Assembly:

System.Data.Common.dll

Contains a collection of TableMapping objects, and is implemented by the DataTableMappingCollection, which is used in common by .NET data providers.

public interface class ITableMappingCollection : System::Collections::IList

public interface ITableMappingCollection : System.Collections.IList

type ITableMappingCollection = interface
    interface ICollection
    interface IEnumerable
    interface IList

Public Interface ITableMappingCollection
Implements IList

Derived

System.Data.Common.DataTableMappingCollection

Implements

ICollection IEnumerable IList

Examples

The following example creates an instance of the derived class, DataTableMapping, and adds it to a DataTableMappingCollection collection. It then informs the user that the mapping was added to the collection.

public void AddDataTableMapping()
{
    // ...
    // create tableMappings
    // ...
    DataTableMapping mapping =
        new DataTableMapping("Categories","DataCategories");
    tableMappings.Add((Object) mapping);
    Console.WriteLine("Table {0} added to {1} table mapping collection.",
        mapping.ToString(), tableMappings.ToString());
}

Public Sub AddDataTableMapping()
    ' ...
    ' create tableMappings
    ' ...
    Dim mapping As New DataTableMapping( _
       "Categories", "DataCategories")
    tableMappings.Add(CType(mapping, Object))
    Console.WriteLine( _
       "Table {0} added to {1} table mapping collection.", _
       mapping.ToString(), tableMappings.ToString())
End Sub

Remarks

The ITableMappingCollection interface allows an inheriting class to implement a TableMapping collection. For more information, see DataAdapter DataTable and DataColumn Mappings.

An application does not create an instance of the ITableMappingCollection interface directly, but creates an instance of a class that inherits ITableMappingCollection.

Classes that inherit ITableMappingCollection must implement the inherited members, and typically define additional members to add provider-specific functionality. For example, the ITableMappingCollection interface defines one implementation of the RemoveAt method. In turn, the DataTableMappingCollection class inherits this method, and defines two additional overloads of RemoveAt.

Notes to Implementers

When you inherit from the ITableMappingCollection interface, you should implement the following constructor:

Item	Description
PrvTableMappingCollection()	Creates an empty PrvTableMappingCollection class.

Properties

Count	Gets the number of elements contained in the ICollection. (Inherited from ICollection)
IsFixedSize	Gets a value indicating whether the IList has a fixed size. (Inherited from IList)
IsReadOnly	Gets a value indicating whether the IList is read-only. (Inherited from IList)
IsSynchronized	Gets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from ICollection)
Item[Int32]	Gets or sets the element at the specified index. (Inherited from IList)
Item[String]	Gets or sets the instance of ITableMapping with the specified SourceTable name.
SyncRoot	Gets an object that can be used to synchronize access to the ICollection. (Inherited from ICollection)

Methods

Add(Object)	Adds an item to the IList. (Inherited from IList)
Add(String, String)	Adds a table mapping to the collection.
Clear()	Removes all items from the IList. (Inherited from IList)
Contains(Object)	Determines whether the IList contains a specific value. (Inherited from IList)
Contains(String)	Gets a value indicating whether the collection contains a table mapping with the specified source table name.
CopyTo(Array, Int32)	Copies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from ICollection)
GetByDataSetTable(String)	Gets the TableMapping object with the specified DataSet table name.
GetEnumerator()	Returns an enumerator that iterates through a collection. (Inherited from IEnumerable)
IndexOf(Object)	Determines the index of a specific item in the IList. (Inherited from IList)
IndexOf(String)	Gets the location of the ITableMapping object within the collection.
Insert(Int32, Object)	Inserts an item to the IList at the specified index. (Inherited from IList)
Remove(Object)	Removes the first occurrence of a specific object from the IList. (Inherited from IList)
RemoveAt(Int32)	Removes the IList item at the specified index. (Inherited from IList)
RemoveAt(String)	Removes the ITableMapping object with the specified SourceTable name from the collection.

Extension Methods

Cast<TResult>(IEnumerable)	Casts the elements of an IEnumerable to the specified type.
OfType<TResult>(IEnumerable)	Filters the elements of an IEnumerable based on a specified type.
AsParallel(IEnumerable)	Enables parallelization of a query.
AsQueryable(IEnumerable)	Converts an IEnumerable to an IQueryable.