IColumnMapping IColumnMapping IColumnMapping IColumnMapping Interface

Definition

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.

public interface class IColumnMapping
public interface IColumnMapping
type IColumnMapping = interface
Public Interface IColumnMapping
Derived

Examples

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 void AddDataColumnMapping() {
   // ...
   // create columnMappings
   // ...
   DataColumnMapping mapping =
      new DataColumnMapping("Description","DataDescription");
   columnMappings.Add((Object) mapping);
   Console.WriteLine("Column {0} added to column mapping collection {1}.", 
       mapping.ToString(), columnMappings.ToString());
}
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

Remarks

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.

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:

Item Description
ColumnMapping() 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.

Properties

DataSetColumn DataSetColumn DataSetColumn DataSetColumn

Gets or sets the name of the column within the DataSet to map to.

SourceColumn SourceColumn SourceColumn SourceColumn

Gets or sets the name of the column within the data source to map from. The name is case-sensitive.

Applies to