mcs/class/System.Data/Documentation/en/System.Data.Common/DataColumnMapping.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="DataColumnMapping" FullName="System.Data.Common.DataColumnMapping">
   3   <TypeSignature Language="C#" Maintainer="auto" Value="public sealed class DataColumnMapping : MarshalByRefObject, ICloneable, System.Data.IColumnMapping" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Data</AssemblyName>
   6     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
   7     <AssemblyVersion>1.0.3300.0</AssemblyVersion>
   8     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   9     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  10   </AssemblyInfo>
  11   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  12   <Base>
  13     <BaseTypeName>System.MarshalByRefObject</BaseTypeName>
  14   </Base>
  15   <Interfaces>
  16     <Interface>
  17       <InterfaceName>System.Data.IColumnMapping</InterfaceName>
  18     </Interface>
  19     <Interface>
  20       <InterfaceName>System.ICloneable</InterfaceName>
  21     </Interface>
  22   </Interfaces>
  23   <Attributes>
  24     <Attribute>
  25       <AttributeName>System.ComponentModel.TypeConverter("System.Data.Common.DataColumnMapping+DataColumnMappingConverter, System.Data, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089")</AttributeName>
  26     </Attribute>
  27   </Attributes>
  28   <Docs>
  29     <remarks>
  30       <attribution license="cc4" from="Microsoft" modified="false" />
  31       <para>A <see cref="T:System.Data.Common.DataColumnMapping" /> enables you to use column names in a <see cref="T:System.Data.DataTable" /> that are different from those in the data source. The DataAdapter uses the mapping to match the columns when the tables in the <see cref="T:System.Data.DataSet" /> or data source are updated. For more information, see <format type="text/html"><a href="D023260A-A66A-4C39-B8F4-090CD130E730">[&lt;topic://cpconsettingupdatatabledatacolumnmappings&gt;]</a></format>.</para>
  32     </remarks>
  33     <summary>
  34       <attribution license="cc4" from="Microsoft" modified="false" />
  35       <para>Contains a generic column mapping for an object that inherits from <see cref="T:System.Data.Common.DataAdapter" />. This class cannot be inherited.</para>
  36     </summary>
  37   </Docs>
  38   <Members>
  39     <Member MemberName=".ctor">
  40       <MemberSignature Language="C#" Value="public DataColumnMapping ();" />
  41       <MemberType>Constructor</MemberType>
  42       <ReturnValue />
  43       <Parameters />
  44       <Docs>
  45         <remarks>To be added</remarks>
  46         <summary>
  47           <attribution license="cc4" from="Microsoft" modified="false" />
  48           <para>Initializes a new instance of the <see cref="T:System.Data.Common.DataColumnMapping" /> class.</para>
  49         </summary>
  50       </Docs>
  51       <AssemblyInfo>
  52         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  53         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  54       </AssemblyInfo>
  55     </Member>
  56     <Member MemberName=".ctor">
  57       <MemberSignature Language="C#" Value="public DataColumnMapping (string sourceColumn, string dataSetColumn);" />
  58       <MemberType>Constructor</MemberType>
  59       <ReturnValue />
  60       <Parameters>
  61         <Parameter Name="sourceColumn" Type="System.String" />
  62         <Parameter Name="dataSetColumn" Type="System.String" />
  63       </Parameters>
  64       <Docs>
  65         <remarks>To be added</remarks>
  66         <summary>
  67           <attribution license="cc4" from="Microsoft" modified="false" />
  68           <para>Initializes a new instance of the <see cref="T:System.Data.Common.DataColumnMapping" /> class with the specified source column name and <see cref="T:System.Data.DataSet" /> column name to map to.</para>
  69         </summary>
  70         <param name="sourceColumn">
  71           <attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive column name from a data source. </param>
  72         <param name="dataSetColumn">
  73           <attribution license="cc4" from="Microsoft" modified="false" />The column name, which is not case sensitive, from a <see cref="T:System.Data.DataSet" /> to map to. </param>
  74       </Docs>
  75       <AssemblyInfo>
  76         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  77         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  78       </AssemblyInfo>
  79     </Member>
  80     <Member MemberName="DataSetColumn">
  81       <MemberSignature Language="C#" Value="public string DataSetColumn { set; get; }" />
  82       <MemberType>Property</MemberType>
  83       <ReturnValue>
  84         <ReturnType>System.String</ReturnType>
  85       </ReturnValue>
  86       <Parameters>
  87       </Parameters>
  88       <Docs>
  89         <value>To be added: an object of type 'string'</value>
  90         <remarks>To be added</remarks>
  91         <summary>
  92           <attribution license="cc4" from="Microsoft" modified="false" />
  93           <para>Gets or sets the name of the column within the <see cref="T:System.Data.DataSet" /> to map to.</para>
  94         </summary>
  95       </Docs>
  96       <AssemblyInfo>
  97         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  98         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  99       </AssemblyInfo>
 100       <Attributes>
 101         <Attribute>
 102           <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
 103         </Attribute>
 104       </Attributes>
 105     </Member>
 106     <Member MemberName="GetDataColumnBySchemaAction">
 107       <MemberSignature Language="C#" Value="public System.Data.DataColumn GetDataColumnBySchemaAction (System.Data.DataTable dataTable, Type dataType, System.Data.MissingSchemaAction schemaAction);" />
 108       <MemberType>Method</MemberType>
 109       <ReturnValue>
 110         <ReturnType>System.Data.DataColumn</ReturnType>
 111       </ReturnValue>
 112       <Parameters>
 113         <Parameter Name="dataTable" Type="System.Data.DataTable" />
 114         <Parameter Name="dataType" Type="System.Type" />
 115         <Parameter Name="schemaAction" Type="System.Data.MissingSchemaAction" />
 116       </Parameters>
 117       <Docs>
 118         <returns>To be added: an object of type 'Data.DataColumn'</returns>
 119         <remarks>To be added</remarks>
 120         <summary>
 121           <attribution license="cc4" from="Microsoft" modified="false" />
 122           <para>Gets a <see cref="T:System.Data.DataColumn" /> from the given <see cref="T:System.Data.DataTable" /> using the <see cref="T:System.Data.MissingSchemaAction" /> and the <see cref="P:System.Data.Common.DataColumnMapping.DataSetColumn" /> property.</para>
 123         </summary>
 124         <param name="dataTable">
 125           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.DataTable" /> to get the column from.</param>
 126         <param name="dataType">
 127           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Type" /> of the data column.</param>
 128         <param name="schemaAction">
 129           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.MissingSchemaAction" /> values.</param>
 130       </Docs>
 131       <AssemblyInfo>
 132         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 133         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 134       </AssemblyInfo>
 135       <Attributes>
 136         <Attribute>
 137           <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 138         </Attribute>
 139       </Attributes>
 140     </Member>
 141     <Member MemberName="GetDataColumnBySchemaAction">
 142       <MemberSignature Language="C#" Value="public static System.Data.DataColumn GetDataColumnBySchemaAction (string sourceColumn, string dataSetColumn, System.Data.DataTable dataTable, Type dataType, System.Data.MissingSchemaAction schemaAction);" />
 143       <MemberType>Method</MemberType>
 144       <AssemblyInfo>
 145         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 146       </AssemblyInfo>
 147       <Attributes>
 148         <Attribute>
 149           <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 150         </Attribute>
 151       </Attributes>
 152       <ReturnValue>
 153         <ReturnType>System.Data.DataColumn</ReturnType>
 154       </ReturnValue>
 155       <Parameters>
 156         <Parameter Name="sourceColumn" Type="System.String" />
 157         <Parameter Name="dataSetColumn" Type="System.String" />
 158         <Parameter Name="dataTable" Type="System.Data.DataTable" />
 159         <Parameter Name="dataType" Type="System.Type" />
 160         <Parameter Name="schemaAction" Type="System.Data.MissingSchemaAction" />
 161       </Parameters>
 162       <Docs>
 163         <returns>To be added.</returns>
 164         <remarks>To be added.</remarks>
 165         <summary>
 166           <attribution license="cc4" from="Microsoft" modified="false" />
 167           <para>A static version of <see cref="M:System.Data.Common.DataColumnMapping.GetDataColumnBySchemaAction(System.Data.DataTable,System.Type,System.Data.MissingSchemaAction)" /> that can be called without instantiating a <see cref="T:System.Data.Common.DataColumnMapping" /> object.</para>
 168         </summary>
 169         <param name="sourceColumn">
 170           <attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive column name from a data source. </param>
 171         <param name="dataSetColumn">
 172           <attribution license="cc4" from="Microsoft" modified="false" />The column name, which is not case sensitive, from a <see cref="T:System.Data.DataSet" /> to map to. </param>
 173         <param name="dataTable">
 174           <attribution license="cc4" from="Microsoft" modified="false" />An instance of <see cref="T:System.Data.DataTable" />.</param>
 175         <param name="dataType">
 176           <attribution license="cc4" from="Microsoft" modified="false" />The data type for the column being mapped.</param>
 177         <param name="schemaAction">
 178           <attribution license="cc4" from="Microsoft" modified="false" />Determines the action to take when existing <see cref="T:System.Data.DataSet" /> schema does not match incoming data.</param>
 179       </Docs>
 180     </Member>
 181     <Member MemberName="SourceColumn">
 182       <MemberSignature Language="C#" Value="public string SourceColumn { set; get; }" />
 183       <MemberType>Property</MemberType>
 184       <ReturnValue>
 185         <ReturnType>System.String</ReturnType>
 186       </ReturnValue>
 187       <Parameters>
 188       </Parameters>
 189       <Docs>
 190         <value>To be added: an object of type 'string'</value>
 191         <remarks>To be added</remarks>
 192         <summary>
 193           <attribution license="cc4" from="Microsoft" modified="false" />
 194           <para>Gets or sets the name of the column within the data source to map from. The name is case-sensitive.</para>
 195         </summary>
 196       </Docs>
 197       <AssemblyInfo>
 198         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 199         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 200       </AssemblyInfo>
 201       <Attributes>
 202         <Attribute>
 203           <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
 204         </Attribute>
 205       </Attributes>
 206     </Member>
 207     <Member MemberName="System.ICloneable.Clone">
 208       <MemberSignature Language="C#" Value="object ICloneable.Clone ();" />
 209       <MemberType>Method</MemberType>
 210       <AssemblyInfo>
 211         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 212         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 213       </AssemblyInfo>
 214       <ReturnValue>
 215         <ReturnType>System.Object</ReturnType>
 216       </ReturnValue>
 217       <Parameters />
 218       <Docs>
 219         <returns>To be added.</returns>
 220         <remarks>
 221           <attribution license="cc4" from="Microsoft" modified="false" />
 222           <para>This member is an explicit interface member implementation. It can be used only when the <see cref="T:System.Data.SqlClient.SqlCommand" /> instance is cast to an <see cref="T:System.ICloneable" /> interface.</para>
 223           <para>For more information, see <see cref="M:System.ICloneable.Clone" />.</para>
 224         </remarks>
 225         <summary>
 226           <attribution license="cc4" from="Microsoft" modified="false" />
 227           <para>Creates a new object that is a copy of the current instance.</para>
 228         </summary>
 229       </Docs>
 230     </Member>
 231     <Member MemberName="ToString">
 232       <MemberSignature Language="C#" Value="public override string ToString ();" />
 233       <MemberType>Method</MemberType>
 234       <ReturnValue>
 235         <ReturnType>System.String</ReturnType>
 236       </ReturnValue>
 237       <Parameters />
 238       <Docs>
 239         <returns>To be added: an object of type 'string'</returns>
 240         <remarks>To be added</remarks>
 241         <summary>
 242           <attribution license="cc4" from="Microsoft" modified="false" />
 243           <para>Converts the current <see cref="P:System.Data.Common.DataColumnMapping.SourceColumn" /> name to a string.</para>
 244         </summary>
 245       </Docs>
 246       <AssemblyInfo>
 247         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 248         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 249       </AssemblyInfo>
 250     </Member>
 251   </Members>
 252 </Type>