linux-packaging-mono/mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls/DetailsViewRowCollection.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="DetailsViewRowCollection" FullName="System.Web.UI.WebControls.DetailsViewRowCollection">
  <TypeSignature Language="C#" Value="public class DetailsViewRowCollection : System.Collections.ICollection" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.Collections.ICollection</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <since version=".NET 2.0" />
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>The <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> class is used to store and manage a collection of <see cref="T:System.Web.UI.WebControls.DetailsViewRow" /> objects in a <see cref="T:System.Web.UI.WebControls.DetailsView" /> control. Each row in a <see cref="T:System.Web.UI.WebControls.DetailsView" /> control is represented by a <see cref="T:System.Web.UI.WebControls.DetailsViewRow" /> object. The <see cref="T:System.Web.UI.WebControls.DetailsView" /> control uses the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> class for its <see cref="P:System.Web.UI.WebControls.DetailsView.Rows" /> property.</para>
      <block subset="none" type="note">
        <para>The <see cref="P:System.Web.UI.WebControls.DetailsView.Rows" /> property contains only the data rows. To access the header row, footer row, top pager row, and bottom pager row, use the <see cref="P:System.Web.UI.WebControls.DetailsView.HeaderRow" />, <see cref="P:System.Web.UI.WebControls.DetailsView.FooterRow" />, <see cref="P:System.Web.UI.WebControls.DetailsView.TopPagerRow" />, and <see cref="P:System.Web.UI.WebControls.DetailsView.BottomPagerRow" /> properties, respectively.</para>
      </block>
      <para>The <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> class supports several ways to access the items in the collection:</para>
      <list type="bullet">
        <item>
          <para>Use the <see cref="P:System.Web.UI.WebControls.DetailsViewRowCollection.Item(System.Int32)" /> indexer to directly retrieve a <see cref="T:System.Web.UI.WebControls.DetailsViewRow" /> object from the collection at a specific zero-based index.</para>
        </item>
        <item>
          <para>Use the <see cref="M:System.Web.UI.WebControls.DetailsViewRowCollection.GetEnumerator" /> method to retrieve an enumerator that can be used to iterate through the collection.</para>
        </item>
        <item>
          <para>Use the <see cref="M:System.Web.UI.WebControls.DetailsViewRowCollection.CopyTo(System.Web.UI.WebControls.DetailsViewRow[],System.Int32)" /> method to copy the items in the collection into an array, which can then be used to access the items in the collection.</para>
        </item>
      </list>
      <para>To determine the total number of items in the collection, use the <see cref="P:System.Web.UI.WebControls.DetailsViewRowCollection.Count" /> property.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Represents a collection of <see cref="T:System.Web.UI.WebControls.DetailsViewRow" /> objects in a <see cref="T:System.Web.UI.WebControls.DetailsView" /> control.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public DetailsViewRowCollection (System.Collections.ArrayList rows);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="rows" Type="System.Collections.ArrayList" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use this constructor to initialize a new instance of the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> class using the specified <see cref="T:System.Collections.ArrayList" /> object. The <see cref="T:System.Collections.ArrayList" /> object contains the <see cref="T:System.Web.UI.WebControls.DetailsViewRow" /> objects with which to populate the collection.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> class using the specified <see cref="T:System.Collections.ArrayList" /> object.</para>
        </summary>
        <param name="rows">
          <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.ArrayList" /> that contains the <see cref="T:System.Web.UI.WebControls.DetailsViewRow" /> objects with which to initialize the collection.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="CopyTo">
      <MemberSignature Language="C#" Value="public void CopyTo (System.Web.UI.WebControls.DetailsViewRow[] array, int index);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="array" Type="System.Web.UI.WebControls.DetailsViewRow[]" />
        <Parameter Name="index" Type="System.Int32" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use this method to copy the items in the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> object into the specified array, starting at the specified index. The array can then be used to access the items in the collection.</para>
          <block subset="none" type="note">
            <para>You must use a zero-based array for the <paramref name="array" /> parameter.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Copies all the items from this <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> object to the specified <see cref="T:System.Array" /> object, starting at the specified index in the <see cref="T:System.Array" />.</para>
        </summary>
        <param name="array">
          <attribution license="cc4" from="Microsoft" modified="false" />A zero-based <see cref="T:System.Array" /> that receives the copied items from the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" />.</param>
        <param name="index">
          <attribution license="cc4" from="Microsoft" modified="false" />The first index in the specified <see cref="T:System.Array" /> to receive the copied contents.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Count">
      <MemberSignature Language="C#" Value="public int Count { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use the <see cref="P:System.Web.UI.WebControls.DetailsViewRowCollection.Count" /> property to determine the number of items in the collection. The <see cref="P:System.Web.UI.WebControls.DetailsViewRowCollection.Count" /> property is commonly used when iterating through the collection to determine its upper bound. The <see cref="P:System.Web.UI.WebControls.DetailsViewRowCollection.Count" /> property is also commonly used to determine whether a collection is empty.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the number of items in the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> object.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="GetEnumerator">
      <MemberSignature Language="C#" Value="public System.Collections.IEnumerator GetEnumerator ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Collections.IEnumerator</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use this method to get an enumerator that can be iterated through linearly to access each item in the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> object. To access the item at the current position in the enumerator, use the <see cref="P:System.Collections.IEnumerator.Current" /> property. Use the <see cref="M:System.Collections.IEnumerator.MoveNext" /> method to move to the next item in the collection. To move the enumerator to its initial position, use the <see cref="M:System.Collections.IEnumerator.Reset" /> method.</para>
          <block subset="none" type="note">
            <para>When you initially get the enumerator or use the <see cref="M:System.Collections.IEnumerator.Reset" /> method to move the enumerator to the first item in the collection, you must call the <see cref="M:System.Collections.IEnumerator.MoveNext" /> method. Otherwise, the item represented by the <see cref="P:System.Collections.IEnumerator.Current" /> property is undefined.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Returns an enumerator that contains all <see cref="T:System.Web.UI.WebControls.DetailsViewRow" /> objects in the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> object.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>An <see cref="T:System.Collections.IEnumerator" />-implemented object that contains all <see cref="T:System.Web.UI.WebControls.DetailsViewRow" /> objects in the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" />.</para>
        </returns>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="IsReadOnly">
      <MemberSignature Language="C#" Value="public bool IsReadOnly { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use the <see cref="P:System.Web.UI.WebControls.DetailsViewRowCollection.IsReadOnly" /> property to determine whether the <see cref="T:System.Web.UI.WebControls.DetailsViewRow" /> objects in the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> object can be modified.</para>
          <block subset="none" type="note">
            <para>This property has been overridden to always return false, to indicate that the <see cref="T:System.Web.UI.WebControls.DetailsViewRow" /> objects in the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> object can be modified in all cases.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets a value indicating whether the rows in the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> object can be modified.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="IsSynchronized">
      <MemberSignature Language="C#" Value="public bool IsSynchronized { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use the <see cref="P:System.Web.UI.WebControls.DetailsViewRowCollection.IsSynchronized" /> property to determine whether the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> object is thread safe.</para>
          <block subset="none" type="note">
            <para>This property has been overridden to always return false to indicate that the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> object is not thread safe.</para>
          </block>
          <para>For more information on the <see cref="P:System.Web.UI.WebControls.DetailsViewRowCollection.IsSynchronized" /> property, see the <see cref="P:System.Collections.ICollection.IsSynchronized" /> property of the <see cref="T:System.Collections.ICollection" /> interface.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets a value indicating whether the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> object is synchronized (thread safe).</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Item">
      <MemberSignature Language="C#" Value="public System.Web.UI.WebControls.DetailsViewRow this[int i] { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Web.UI.WebControls.DetailsViewRow</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="i" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="i">To be added.</param>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="SyncRoot">
      <MemberSignature Language="C#" Value="public object SyncRoot { get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use the <see cref="P:System.Web.UI.WebControls.DetailsViewRowCollection.SyncRoot" /> property to get an object that can be used to synchronize access to the collection. The object returned in this implementation is the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> object itself.</para>
          <para>For more information on the <see cref="P:System.Web.UI.WebControls.DetailsViewRowCollection.SyncRoot" /> property, see the <see cref="P:System.Collections.ICollection.SyncRoot" /> property of the <see cref="T:System.Collections.ICollection" /> interface.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets the object used to synchronize access to the collection.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="System.Collections.ICollection.CopyTo">
      <MemberSignature Language="C#" Value="void ICollection.CopyTo (Array array, int index);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="array" Type="System.Array" />
        <Parameter Name="index" Type="System.Int32" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>This implementation of the <see cref="M:System.Web.UI.WebControls.DetailsViewRowCollection.System.Collections.ICollection.CopyTo(System.Array,System.Int32)" /> method is a helper method used by the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> class to copy the items in the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> object into the specified <see cref="T:System.Array" /> object, starting at the specified index. The <see cref="T:System.Array" /> object can then be used to access the items in the collection.</para>
          <block subset="none" type="note">
            <para>You must use a zero-based <see cref="T:System.Array" /> object for the <paramref name="array" /> parameter.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Copies all the items from this <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" /> object to the specified <see cref="T:System.Array" /> object, starting at the specified index in the <see cref="T:System.Array" />.</para>
        </summary>
        <param name="array">
          <attribution license="cc4" from="Microsoft" modified="false" />A zero-based <see cref="T:System.Array" /> that receives the copied items from the <see cref="T:System.Web.UI.WebControls.DetailsViewRowCollection" />.</param>
        <param name="index">
          <attribution license="cc4" from="Microsoft" modified="false" />The first index in the specified <see cref="T:System.Array" /> to receive the copied contents.</param>
      </Docs>
    </Member>
  </Members>
</Type>