ITableMapping Interface
TOC
Collapse the table of content
Expand the table of content

ITableMapping Interface

 

Associates a source table with a table in a DataSet, and is implemented by the DataTableMapping class, which is used in common by .NET Framework data providers.

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

Public Interface ITableMapping

NameDescription
System_CAPS_pubpropertyColumnMappings

Gets the derived DataColumnMappingCollection for the DataTable.

System_CAPS_pubpropertyDataSetTable

Gets or sets the case-insensitive name of the table within the DataSet.

System_CAPS_pubpropertySourceTable

Gets or sets the case-sensitive name of the source table.

The ITableMapping interface allows an inheriting class to implement a TableMapping class, which associates a data source column with a DataSet column. For more information, see DataAdapter DataTable and DataColumn Mappings.

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

Classes that inherit ITableMapping must implement the inherited members, and typically define additional members to add provider-specific functionality. For example, the ITableMapping interface defines the DataSetTable property. In turn, the DataTableMapping class inherits this property, and also defines the GetDataTableBySchemaAction method.

Notes to Implementers:

When you inherit from the ITableMapping interface, you should implement the following constructors:

Item

Description

DataTableMapping()

Initializes a new instance of the TableMapping class.

TableMapping(string sourceTable, string dataSetTable)

Initializes a new instance of the TableMapping class with a source when given a source table name and a DataTable name.

TableMapping(string sourceTable, string dataSetTable, DataColumnMapping[] columnMappings)

Initializes a new instance of the TableMapping class when given a source table name, a DataTable name, and an array of ColumnMapping objects.

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 and displays the parent mapping.

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

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft