WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class RecordsInDetailsCollection

    Show / Hide Table of Contents

    Class RecordsInDetailsCollection

    A Read-only collection of Record elements that are children of a RecordsDetails section. An instance of this collection is returned by the Records property of a RecordsDetails object. The Records property of a Group also returns an instance of this collection if the group's details section contains records (and not groups). Otherwise an empty collection is returned.

    Inheritance
    System.Object
    RecordsInDetailsCollection
    Implements
    System.Collections.IList
    System.Collections.ICollection
    System.Collections.IEnumerable
    System.IDisposable
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.Grouping
    Assembly: Syncfusion.Grouping.Base.dll
    Syntax
    public class RecordsInDetailsCollection : IList, ICollection, IEnumerable, IDisposable

    Fields

    Empty

    A Read-only and empty collection.

    Declaration
    public static RecordsInDetailsCollection Empty
    Field Value
    Type Description
    RecordsInDetailsCollection

    Properties

    Count

    Gets the number of elements contained in the collection. The property also ensures that the collection is in sync with the underlying table if changes have been made to the Table or the TableDescriptor.

    Declaration
    public int Count { get; }
    Property Value
    Type Description
    System.Int32
    Remarks

    The method calls EnsureInitialized(Object, Boolean) of the Group.

    IsFixedSize

    Returns False since this collection has no fixed size.

    Declaration
    public bool IsFixedSize { get; }
    Property Value
    Type Description
    System.Boolean

    IsReadOnly

    Returns True because this collection is always Read-only.

    Declaration
    public bool IsReadOnly { get; }
    Property Value
    Type Description
    System.Boolean

    IsSynchronized

    Returns whether the collection of rows is synchronized or not.

    Declaration
    public bool IsSynchronized { get; }
    Property Value
    Type Description
    System.Boolean

    Item[Int32]

    Gets the element at the zero-based index. Setting is not supported and will throw an exception since the collection is Read-only.

    Declaration
    public Record this[int index] { get; set; }
    Parameters
    Type Name Description
    System.Int32 index
    Property Value
    Type Description
    Record
    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the Table or the TableDescriptor.

    The method calls EnsureInitialized(Object, Boolean).

    Item[String]

    Searches for the first occurrence of a record that matches the sort-key and returns the record found or NULL if not found.

    Declaration
    public Record this[string sortKey] { get; }
    Parameters
    Type Name Description
    System.String sortKey

    The sort key to search for. The sortKey will be compared to the sorted field in the table as specified with SortedColumns.

    Property Value
    Type Description
    Record
    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the Table or the TableDescriptor.

    The method calls EnsureInitialized(Object, Boolean).

    Methods

    Contains(Record)

    Determines if the element belongs to this collection.

    Declaration
    public bool Contains(Record value)
    Parameters
    Type Name Description
    Record value

    The Object to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).

    Returns
    Type Description
    System.Boolean

    True if item is found in the collection; otherwise, False.

    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the Table or the TableDescriptor.

    The method calls EnsureInitialized(Object, Boolean).

    Contains(String)

    Determines if a record exists in the collection that matches the sort-key.

    Declaration
    public bool Contains(string sortKey)
    Parameters
    Type Name Description
    System.String sortKey

    The sort key to search for. The sortKey will be compared to the sorted field in the table as specified with SortedColumns.

    Returns
    Type Description
    System.Boolean

    True if the record exists; False otherwise.

    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the Table or the TableDescriptor.

    The method calls EnsureInitialized(Object, Boolean).

    CopyTo(Record[], Int32)

    Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.

    Declaration
    public int CopyTo(Record[] array, int index)
    Parameters
    Type Name Description
    Record[] array

    The one-dimensional array that is the destination of the elements copied from ArrayList. The Array must have zero-based indexing.

    System.Int32 index

    The zero-based index in array at which copying begins.

    Returns
    Type Description
    System.Int32

    Returns record index.

    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the Table or the TableDescriptor.

    The method calls EnsureInitialized(Object, Boolean).

    Dispose()

    Disposes the object and resets reference to objects.

    Declaration
    public void Dispose()

    FindRecord(Object)

    Searches for the first occurrence of a record that matches the specified sort-key and returns the zero-based index of the first occurrence found or -1 if not found.

    Declaration
    public int FindRecord(object sortKey)
    Parameters
    Type Name Description
    System.Object sortKey

    The sort key to search for. The object will be compared to the sorted fields in the table as specified with SortedColumns.

    Returns
    Type Description
    System.Int32

    Index of the record.

    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the Table or the TableDescriptor.

    The method calls EnsureInitialized(Object, Boolean).

    FindRecord(Object[])

    Searches for the first occurrence of a record that matches the specified sort-key and returns the zero-based index of the first occurrence found or -1 if not found.

    Declaration
    public int FindRecord(params object[] sortKeys)
    Parameters
    Type Name Description
    System.Object[] sortKeys

    The sort keys to search for. The object will be compared to the sorted fields in the table as specified with SortedColumns. The sortKeys must have the same order of fields as the SortedColumns collection.

    Returns
    Type Description
    System.Int32

    Record index.

    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the Table or the TableDescriptor.

    The method calls EnsureInitialized(Object, Boolean).

    Examples
    product21.ParentTable.TableDescriptor.SortedColumns.Add("ProductName");
    product21.ParentTable.TableDescriptor.SortedColumns.Add("SupplierID");
    int sp = product21.Records.FindRecord("Spegesild", "21");
    product21.Records["Spegesild"].SetCurrent();
    product21.ParentTable.TableDescriptor.SortedColumns.Add("ProductName")
    product21.ParentTable.TableDescriptor.SortedColumns.Add("SupplierID")
    Dim sp As Integer = product21.Records.FindRecord("Spegesild", "21")
    product21.Records("Spegesild").SetCurrent()

    GetEnumerator()

    Returns an enumerator for the entire collection.

    Declaration
    public RecordsInDetailsCollectionEnumerator GetEnumerator()
    Returns
    Type Description
    RecordsInDetailsCollectionEnumerator

    An Enumerator for the entire collection.

    Remarks

    Enumerators only allow reading the of data in the collection. Enumerators cannot be used to modify the underlying collection.

    GetNext(Record)

    Returns the next record in the collection.

    Declaration
    public Record GetNext(Record r)
    Parameters
    Type Name Description
    Record r

    The Record.

    Returns
    Type Description
    Record

    Next record.

    GetPrevious(Record)

    Returns the previous record in the collection.

    Declaration
    public Record GetPrevious(Record r)
    Parameters
    Type Name Description
    Record r

    The Record.

    Returns
    Type Description
    Record

    Previous record.

    IndexOf(Record)

    Returns the zero-based index of the occurrence of the element in the collection.

    Declaration
    public int IndexOf(Record value)
    Parameters
    Type Name Description
    Record value

    The element to locate in the collection. The value can be a NULL reference (Nothing in Visual Basic).

    Returns
    Type Description
    System.Int32

    The zero-based index of the occurrence of the element within the entire collection, if found; otherwise, -1.

    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the Table or the TableDescriptor.

    The method calls EnsureInitialized(Object, Boolean).

    IndexOf(String)

    Searches for the first occurrence of a record that matches the sort-key and returns the zero-based index of the first occurrence found or -1 if not found.

    Declaration
    public int IndexOf(string sortKey)
    Parameters
    Type Name Description
    System.String sortKey

    The sort key to search for. The sortKey will be compared to the sorted field in the table as specified with SortedColumns.

    Returns
    Type Description
    System.Int32

    Record index.

    Remarks

    The method ensures that the collection is in sync with the underlying table if changes have been made to the Table or the TableDescriptor.

    The method calls EnsureInitialized(Object, Boolean).

    Explicit Interface Implementations

    ICollection.CopyTo(Array, Int32)

    Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.

    Declaration
    void ICollection.CopyTo(Array array, int index)
    Parameters
    Type Name Description
    System.Array array

    The one-dimensional array that is the destination of the elements copied from the ArrayList. The array must have zero-based indexing.

    System.Int32 index

    The zero-based index in an array at which copying begins.

    ICollection.SyncRoot

    Returns whether collection of rows can be synchronized.

    Declaration
    object ICollection.SyncRoot { get; }
    Returns
    Type Description
    System.Object

    IEnumerable.GetEnumerator()

    Returns an enumerator for the entire collection.

    Declaration
    IEnumerator IEnumerable.GetEnumerator()
    Returns
    Type Description
    System.Collections.IEnumerator

    An Enumerator for the entire collection.

    Remarks

    Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection.

    IList.Add(Object)

    Adds a row object to the end of the collection.

    Declaration
    int IList.Add(object value)
    Parameters
    Type Name Description
    System.Object value

    The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic).

    Returns
    Type Description
    System.Int32
    Exceptions
    Type Condition
    System.InvalidOperationException

    Collection is Read-only.

    IList.Clear()

    Removes all rows from the DataTableList.

    Declaration
    void IList.Clear()
    Exceptions
    Type Condition
    System.InvalidOperationException

    Collection is Read-only.

    IList.Contains(Object)

    Checks whether the specified value is in list or not.

    Declaration
    bool IList.Contains(object value)
    Parameters
    Type Name Description
    System.Object value

    The System.Object to locate in the System.Collections.IList.

    Returns
    Type Description
    System.Boolean

    Returns the value that belongs to collection.

    IList.get_Item(Int32)

    Declaration
    object IList.get_Item(int index)
    Parameters
    Type Name Description
    System.Int32 index
    Returns
    Type Description
    System.Object

    IList.IndexOf(Object)

    Returns the index of the specified value.

    Declaration
    int IList.IndexOf(object value)
    Parameters
    Type Name Description
    System.Object value

    The System.Object to locate in the System.Collections.IList.

    Returns
    Type Description
    System.Int32

    The index of value if found in the list.

    IList.Insert(Int32, Object)

    Inserts an element into the collection at the specified index.

    Declaration
    void IList.Insert(int index, object value)
    Parameters
    Type Name Description
    System.Int32 index

    The zero-based index at which the element should be inserted.

    System.Object value

    The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).

    Exceptions
    Type Condition
    System.InvalidOperationException

    Collection is Read-only.

    IList.Item[Int32]

    Gets or sets the index from the collection.

    Declaration
    object IList.this[] { get; set; }
    Parameters
    Type Name Description
    System.Int32 index

    the index of an record.

    Returns
    Type Description
    System.Object

    Returns the index of an record.

    Exceptions
    Type Condition
    System.InvalidOperationException

    Collection is Read-only.

    IList.Remove(Object)

    Removes the specified row object from the collection.

    Declaration
    void IList.Remove(object value)
    Parameters
    Type Name Description
    System.Object value

    The element to remove from the collection. If the value is NULL or the element is not contained in the collection, the method will do nothing.

    Exceptions
    Type Condition
    System.InvalidOperationException

    Collection is Read-only.

    IList.RemoveAt(Int32)

    Removes the element at the specified index of the collection.

    Declaration
    void IList.RemoveAt(int index)
    Parameters
    Type Name Description
    System.Int32 index

    The zero-based index of the element to remove.

    Exceptions
    Type Condition
    System.InvalidOperationException

    Collection is Read-only.

    IList.set_Item(Int32, Object)

    Declaration
    void IList.set_Item(int index, object value)
    Parameters
    Type Name Description
    System.Int32 index
    System.Object value

    Implements

    System.Collections.IList
    System.Collections.ICollection
    System.Collections.IEnumerable
    System.IDisposable

    Extension Methods

    EnumerableExtensions.GetElementType(IEnumerable)
    EnumerableExtensions.GetItemPropertyInfo(IEnumerable)
    FunctionalExtensions.ForEach<T>(IEnumerable, Action<T>)
    FunctionalExtensions.ToList<T>(IEnumerable)
    FunctionalExtensions.MoveTo(IList, Int32, Int32)
    QueryableExtensions.OfQueryable(IEnumerable)
    QueryableExtensions.OfQueryable(IEnumerable, Type)
    QueryableExtensions.GroupByMany<TElement>(IEnumerable, Type, List<Func<TElement, Object>>)
    QueryableExtensions.GroupByMany(IEnumerable, Type, Func<String, Expression>, String[])
    QueryableExtensions.GroupByMany(IEnumerable, Type, List<SortDescriptor>, Dictionary<String, IComparer<Object>>, Func<String, Expression>, String[])
    QueryableExtensions.GroupByMany(IEnumerable, Type, List<SortDescriptor>, Func<String, Expression>, String[])
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved