This documentation is archived and is not being maintained.

DataColumn.ColumnMapping Property

Gets or sets the MappingType of the column.

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

Public Overridable Property ColumnMapping As MappingType

Property Value

Type: System.Data.MappingType
One of the MappingType values.

The ColumnMapping property determines how a DataColumn is mapped when a DataSet is saved as an XML document using the WriteXml method.

For example, if a DataColumn is named "customerID," and its ColumnMapping property is set to MappingType.Element, the column value will produce the following XML:


However, if the same column is mapped to MappingType.Attribute, the following XML is produced:

 <Customers customerID="ALFKI"........more attributes.....>
  <Order orderID="1234"....more attributes..../>
  <Order orderID="1234"....more attributes..../>
 ...... More orders for this customer

Use the DataColumn constructor that contains the type argument to specificy how the DataColumn is mapped when its DataSet is transformed to an XML document.

The ColumnMapping property corresponds to the constructor argument type.

The following example sets the ColumnMapping type property of new DataColumn.

Private Sub AddColumn(table As DataTable )
    ' Create a new column and set its properties.
    Dim column As DataColumn = New DataColumn("ID", _
        Type.GetType("System.Int32"), "", MappingType.Attribute)
    column.DataType = Type.GetType("System.String")
    column.ColumnMapping = MappingType.Element

    ' Add the column the table's columns collection.
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.