This documentation is archived and is not being maintained.

IColumnMapping Interface

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

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

Public Interface IColumnMapping

The IColumnMapping type exposes the following members.

Public propertySupported by the XNA FrameworkDataSetColumnGets or sets the name of the column within the DataSet to map to.
Public propertySupported by the XNA FrameworkSourceColumnGets or sets the name of the column within the data source to map from. The name is case-sensitive.

The IColumnMapping interface enables an inheriting class to implement a Column Mapping class, which associates a data source column with a DataSet column. For more information, see DataAdapter DataTable and DataColumn Mappings (ADO.NET).

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

Classes that inherit IColumnMapping must implement all inherited members, and typically define additional members to add provider-specific functionality. For example, the IColumnMapping interface defines the DataSetColumn property. In turn, the DataColumnMapping class inherits this property, and also defines the GetDataColumnBySchemaAction method.

Notes to Implementers

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




Initializes a new instance of the ColumnMapping class.

ColumnMapping(string sourceColumn, string dataSetColumn)

Initializes a new instance of the ColumnMapping class with a source with the specified source column name and DataSet column name.

The following example creates an instance of the derived class, DataColumnMapping, and adds it to a DataColumnMappingCollection collection. It then tells the user that the mapping was added to the collection and shows the parent for the mapping.

Public Sub AddDataColumnMapping()
    ' ...
    ' create columnMappings
    ' ...
    Dim mapping As New DataColumnMapping( _
       "Description", "DataDescription")
    columnMappings.Add(CType(mapping, Object))
    Console.WriteLine("Column {0} added to column mapping collection {1}.", _
       mapping.ToString(), columnMappings.ToString())
End Sub

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