mcs/class/System.Data/Documentation/en/System.Data/DataViewSettingCollection.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="DataViewSettingCollection" FullName="System.Data.DataViewSettingCollection">
   3   <TypeSignature Language="C#" Maintainer="auto" Value="public class DataViewSettingCollection : System.Collections.ICollection" />
   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.Object</BaseTypeName>
  14   </Base>
  15   <Interfaces>
  16     <Interface>
  17       <InterfaceName>System.Collections.ICollection</InterfaceName>
  18     </Interface>
  19   </Interfaces>
  20   <Attributes>
  21     <Attribute>
  22       <AttributeName>System.ComponentModel.Editor("Microsoft.VSDesigner.Data.Design.DataViewSettingsCollectionEditor, Microsoft.VSDesigner, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
  23     </Attribute>
  24   </Attributes>
  25   <Docs>
  26     <remarks>
  27       <attribution license="cc4" from="Microsoft" modified="false" />
  28       <para>A user cannot add or remove a <see cref="T:System.Data.DataViewSetting" /> from the collection, but can change the properties of the <see cref="T:System.Data.DataViewSetting" /> corresponding to a particular <see cref="T:System.Data.DataTable" />. Adding or removing a <see cref="T:System.Data.DataTable" /> from the DataSet adds or removes the corresponding <see cref="T:System.Data.DataViewSetting" /> from the collection.</para>
  29     </remarks>
  30     <summary>
  31       <attribution license="cc4" from="Microsoft" modified="false" />
  32       <para>Contains a read-only collection of <see cref="T:System.Data.DataViewSetting" /> objects for each <see cref="T:System.Data.DataTable" /> in a <see cref="T:System.Data.DataSet" />.</para>
  33     </summary>
  34   </Docs>
  35   <Members>
  36     <Member MemberName="CopyTo">
  37       <MemberSignature Language="C#" Value="public void CopyTo (Array ar, int index);" />
  38       <MemberType>Method</MemberType>
  39       <ReturnValue>
  40         <ReturnType>System.Void</ReturnType>
  41       </ReturnValue>
  42       <Parameters>
  43         <Parameter Name="ar" Type="System.Array" />
  44         <Parameter Name="index" Type="System.Int32" />
  45       </Parameters>
  46       <Docs>
  47         <remarks>To be added</remarks>
  48         <summary>
  49           <attribution license="cc4" from="Microsoft" modified="false" />
  50           <para>Copies the collection objects to a one-dimensional <see cref="T:System.Array" /> instance starting at the specified index.</para>
  51         </summary>
  52         <param name="ar">
  53           <attribution license="cc4" from="Microsoft" modified="false" />The one-dimensional <see cref="T:System.Array" /> that is the destination of the values copied from the collection. </param>
  54         <param name="index">
  55           <attribution license="cc4" from="Microsoft" modified="false" />The index of the array at which to start inserting. </param>
  56       </Docs>
  57       <AssemblyInfo>
  58         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  59         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  60       </AssemblyInfo>
  61     </Member>
  62     <Member MemberName="CopyTo">
  63       <MemberSignature Language="C#" Value="public void CopyTo (System.Data.DataViewSetting[] ar, int index);" />
  64       <MemberType>Method</MemberType>
  65       <AssemblyInfo>
  66         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  67       </AssemblyInfo>
  68       <ReturnValue>
  69         <ReturnType>System.Void</ReturnType>
  70       </ReturnValue>
  71       <Parameters>
  72         <Parameter Name="ar" Type="System.Data.DataViewSetting[]" />
  73         <Parameter Name="index" Type="System.Int32" />
  74       </Parameters>
  75       <Docs>
  76         <remarks>To be added.</remarks>
  77         <summary>
  78           <attribution license="cc4" from="Microsoft" modified="false" />
  79           <para>Copies the collection objects to a one-dimensional <see cref="T:System.Array" /> instance starting at the specified index.</para>
  80         </summary>
  81         <param name="ar">
  82           <attribution license="cc4" from="Microsoft" modified="false" />The one-dimensional <see cref="T:System.Array" /> that is the destination of the values copied from the collection. </param>
  83         <param name="index">
  84           <attribution license="cc4" from="Microsoft" modified="false" />The index of the array at which to start inserting. </param>
  85       </Docs>
  86     </Member>
  87     <Member MemberName="Count">
  88       <MemberSignature Language="C#" Value="public virtual int Count { get; }" />
  89       <MemberType>Property</MemberType>
  90       <ReturnValue>
  91         <ReturnType>System.Int32</ReturnType>
  92       </ReturnValue>
  93       <Docs>
  94         <value>To be added: an object of type 'int'</value>
  95         <remarks>
  96           <attribution license="cc4" from="Microsoft" modified="false" />
  97           <para>The number of <see cref="T:System.Data.DataViewSetting" /> objects is the same as the number of <see cref="T:System.Data.DataTable" /> objects in the <see cref="T:System.Data.DataSet" />.</para>
  98         </remarks>
  99         <summary>
 100           <attribution license="cc4" from="Microsoft" modified="false" />
 101           <para>Gets the number of <see cref="T:System.Data.DataViewSetting" /> objects in the <see cref="T:System.Data.DataViewSettingCollection" />.</para>
 102         </summary>
 103       </Docs>
 104       <AssemblyInfo>
 105         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 106         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 107       </AssemblyInfo>
 108       <Attributes>
 109         <Attribute>
 110           <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
 111         </Attribute>
 112       </Attributes>
 113     </Member>
 114     <Member MemberName="GetEnumerator">
 115       <MemberSignature Language="C#" Value="public System.Collections.IEnumerator GetEnumerator ();" />
 116       <MemberType>Method</MemberType>
 117       <ReturnValue>
 118         <ReturnType>System.Collections.IEnumerator</ReturnType>
 119       </ReturnValue>
 120       <Parameters />
 121       <Docs>
 122         <returns>To be added: an object of type 'Collections.IEnumerator'</returns>
 123         <remarks>To be added</remarks>
 124         <summary>
 125           <attribution license="cc4" from="Microsoft" modified="false" />
 126           <para>Gets an <see cref="T:System.Collections.IEnumerator" /> for the collection.</para>
 127         </summary>
 128       </Docs>
 129       <AssemblyInfo>
 130         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 131         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 132       </AssemblyInfo>
 133     </Member>
 134     <Member MemberName="IsReadOnly">
 135       <MemberSignature Language="C#" Value="public bool IsReadOnly { get; }" />
 136       <MemberType>Property</MemberType>
 137       <ReturnValue>
 138         <ReturnType>System.Boolean</ReturnType>
 139       </ReturnValue>
 140       <Docs>
 141         <value>To be added: an object of type 'bool'</value>
 142         <remarks>To be added</remarks>
 143         <summary>
 144           <attribution license="cc4" from="Microsoft" modified="false" />
 145           <para>Gets a value that indicates whether the <see cref="T:System.Data.DataViewSettingCollection" /> is read-only.</para>
 146         </summary>
 147       </Docs>
 148       <AssemblyInfo>
 149         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 150         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 151       </AssemblyInfo>
 152       <Attributes>
 153         <Attribute>
 154           <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
 155         </Attribute>
 156       </Attributes>
 157     </Member>
 158     <Member MemberName="IsSynchronized">
 159       <MemberSignature Language="C#" Value="public bool IsSynchronized { get; }" />
 160       <MemberType>Property</MemberType>
 161       <ReturnValue>
 162         <ReturnType>System.Boolean</ReturnType>
 163       </ReturnValue>
 164       <Docs>
 165         <value>To be added: an object of type 'bool'</value>
 166         <remarks>
 167           <attribution license="cc4" from="Microsoft" modified="false" />
 168           <para>This property implements the <see cref="T:System.Collections.ICollection" /> interface.</para>
 169           <para>Derived classes can provide a synchronized version of the <see cref="T:System.Data.DataViewSettingCollection" /> using the <see cref="P:System.Data.DataViewSettingCollection.SyncRoot" /> property.</para>
 170         </remarks>
 171         <summary>
 172           <attribution license="cc4" from="Microsoft" modified="false" />
 173           <para>Gets a value that indicates whether access to the <see cref="T:System.Data.DataViewSettingCollection" /> is synchronized (thread-safe).</para>
 174         </summary>
 175       </Docs>
 176       <AssemblyInfo>
 177         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 178         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 179       </AssemblyInfo>
 180       <Attributes>
 181         <Attribute>
 182           <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
 183         </Attribute>
 184       </Attributes>
 185     </Member>
 186     <Member MemberName="Item">
 187       <MemberSignature Language="C#" Value="public virtual System.Data.DataViewSetting this[System.Data.DataTable table] { set; get; }" />
 188       <MemberType>Property</MemberType>
 189       <ReturnValue>
 190         <ReturnType>System.Data.DataViewSetting</ReturnType>
 191       </ReturnValue>
 192       <Parameters>
 193         <Parameter Name="table" Type="System.Data.DataTable" />
 194       </Parameters>
 195       <Docs>
 196         <param name="table">To be added.</param>
 197         <summary>To be added</summary>
 198         <value>To be added: an object of type 'DataViewSetting'</value>
 199         <remarks>To be added</remarks>
 200       </Docs>
 201       <AssemblyInfo>
 202         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 203         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 204       </AssemblyInfo>
 205     </Member>
 206     <Member MemberName="Item">
 207       <MemberSignature Language="C#" Value="public virtual System.Data.DataViewSetting this[int index] { set; get; }" />
 208       <MemberType>Property</MemberType>
 209       <ReturnValue>
 210         <ReturnType>System.Data.DataViewSetting</ReturnType>
 211       </ReturnValue>
 212       <Parameters>
 213         <Parameter Name="index" Type="System.Int32" />
 214       </Parameters>
 215       <Docs>
 216         <param name="index">To be added: an object of type 'int'</param>
 217         <summary>To be added</summary>
 218         <value>To be added: an object of type 'DataViewSetting'</value>
 219         <remarks>To be added</remarks>
 220       </Docs>
 221       <AssemblyInfo>
 222         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 223         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 224       </AssemblyInfo>
 225     </Member>
 226     <Member MemberName="Item">
 227       <MemberSignature Language="C#" Value="public virtual System.Data.DataViewSetting this[string tableName] { get; }" />
 228       <MemberType>Property</MemberType>
 229       <AssemblyInfo>
 230         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 231         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 232       </AssemblyInfo>
 233       <ReturnValue>
 234         <ReturnType>System.Data.DataViewSetting</ReturnType>
 235       </ReturnValue>
 236       <Parameters>
 237         <Parameter Name="tableName" Type="System.String" />
 238       </Parameters>
 239       <Docs>
 240         <param name="tableName">To be added.</param>
 241         <summary>To be added.</summary>
 242         <value>To be added.</value>
 243         <remarks>To be added.</remarks>
 244       </Docs>
 245     </Member>
 246     <Member MemberName="SyncRoot">
 247       <MemberSignature Language="C#" Value="public object SyncRoot { get; }" />
 248       <MemberType>Property</MemberType>
 249       <ReturnValue>
 250         <ReturnType>System.Object</ReturnType>
 251       </ReturnValue>
 252       <Docs>
 253         <value>To be added: an object of type 'object'</value>
 254         <remarks>
 255           <attribution license="cc4" from="Microsoft" modified="false" />
 256           <para>Derived classes can provide a synchronized version of the <see cref="T:System.Data.DataViewSettingCollection" /> using the <see cref="P:System.Data.DataViewSettingCollection.SyncRoot" /> property.</para>
 257           <para>Program code must always perform synchronized operations on the <see cref="P:System.Data.DataViewSettingCollection.SyncRoot" /> of the <see cref="T:System.Data.DataViewSettingCollection" />, not directly on the <see cref="T:System.Data.DataViewSettingCollection" />. This guarantees the correct operation of collections that are derived from other objects. Specifically, it maintains the correct synchronization with other threads that might be simultaneously modifying the <see cref="T:System.Data.DataViewSettingCollection" />.</para>
 258         </remarks>
 259         <summary>
 260           <attribution license="cc4" from="Microsoft" modified="false" />
 261           <para>Gets an object that can be used to synchronize access to the <see cref="T:System.Data.DataViewSettingCollection" />.</para>
 262         </summary>
 263       </Docs>
 264       <AssemblyInfo>
 265         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 266         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 267       </AssemblyInfo>
 268       <Attributes>
 269         <Attribute>
 270           <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
 271         </Attribute>
 272       </Attributes>
 273     </Member>
 274   </Members>
 275 </Type>