WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class NestedTablesCollection - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class NestedTablesCollection

    Represents the class that provides a collection of NestedTable elements that are children of a Record. An instance of this collection is returned by the NestedTables property of a Record object. Each NestedTable has a ChildTable that links the record in a parent table to the child records in a related table.

    Inheritance
    System.Object
    NestedTablesCollection
    Implements
    System.Collections.IList
    System.Collections.ICollection
    System.Collections.IEnumerable
    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 NestedTablesCollection : IList, ICollection, IEnumerable

    Properties

    Count

    Gets the number of elements contained in the collection.

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

    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.

    If changes in the TableDescriptor are detected, the method will reinitialize the collection before returning the count.

    IsFixedSize

    Gets a value indicating whether the collection is of fixed size or not.

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

    IsReadOnly

    Gets a value indicating whether the collection is read-only or not.

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

    IsSynchronized

    Gets a value indicating whether the object can be used to synchronize access to the collection or not.

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

    Item[Int32]

    Gets or sets the element at the zero-based index.

    Declaration
    public NestedTable this[int index] { get; set; }
    Parameters
    Type Name Description
    System.Int32 index
    Property Value
    Type Description
    NestedTable
    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    If the index is invalid.

    Item[String]

    Gets or sets the element with the specified name.

    Declaration
    public NestedTable this[string name] { get; set; }
    Parameters
    Type Name Description
    System.String name
    Property Value
    Type Description
    NestedTable
    Exceptions
    Type Condition
    System.ArgumentException

    If the index is invalid.

    Methods

    Add(NestedTable)

    Adds a value to the end of the collection.

    Declaration
    public int Add(NestedTable nestedTable)
    Parameters
    Type Name Description
    NestedTable nestedTable

    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

    The zero-based collection index at which the value has been added.

    Clear()

    Removes the item from the collection.

    Declaration
    public void Clear()

    Contains(NestedTable)

    Determines whether the element belongs to this collection or not.

    Declaration
    public bool Contains(NestedTable value)
    Parameters
    Type Name Description
    NestedTable 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 the element with the specified name belongs to this collection.

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

    The name of the element to locate in the collection.

    Returns
    Type Description
    System.Boolean

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

    CopyTo(NestedTable[], Int32)

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

    Declaration
    public void CopyTo(NestedTable[] array, int index)
    Parameters
    Type Name Description
    NestedTable[] 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 an array at which copying begins.

    GetEnumerator()

    Gets an enumerator that iterates through a collection.

    Declaration
    public NestedTablesCollectionEnumerator GetEnumerator()
    Returns
    Type Description
    NestedTablesCollectionEnumerator

    An instance of the NestedTablesCollectionEnumerator class.

    Remarks

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

    IndexOf(NestedTable)

    Determines and gets the index of the specific item in the collection.

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

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

    Returns
    Type Description
    System.Int32

    The index of value if found in the list; Otherwise, -1.

    IndexOf(String)

    Searches for the element with the specified name.

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

    The name of the element to locate in the collection.

    Returns
    Type Description
    System.Int32

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

    Insert(Int32, NestedTable)

    Inserts an element into the collection at the specified index.

    Declaration
    public void Insert(int index, NestedTable nestedTable)
    Parameters
    Type Name Description
    System.Int32 index

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

    NestedTable nestedTable

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

    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).

    Remove(NestedTable)

    Removes the specified element from the collection.

    Declaration
    public void Remove(NestedTable value)
    Parameters
    Type Name Description
    NestedTable value

    The item to be removed.

    Remarks

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

    RemoveAt(Int32)

    Removes the collection item at the specific index.

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

    The zero-based index of the item to be removed.

    Explicit Interface Implementations

    ICollection.CopyTo(Array, Int32)

    Copies the elements of the collection from a specific array index.

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

    The single-dimensional zero-based array that stores the items.

    System.Int32 index

    The zero-based array index.

    ICollection.SyncRoot

    Gets an object that can be used to synchronize access to the collection.

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

    IEnumerable.GetEnumerator()

    Gets an enumerator that iterates through a collection.

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

    An instance of the System.Collections.IEnumerator class that can be used to iterate through the collection.

    IList.Add(Object)

    Adds the item to the collection.

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

    The item to be added in the collection.

    Returns
    Type Description
    System.Int32

    The position into which the new element was inserted, or -1 to indicate that the item is not inserted.

    IList.Contains(Object)

    Determines a value indicating whether the specified item is in the collection or not.

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

    The item to be checked.

    Returns
    Type Description
    System.Boolean

    True if the item is in the collection;Otherwise False.

    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)

    Determines and gets the index of the specific item in the collection.

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

    The item to be located in the collection.

    Returns
    Type Description
    System.Int32

    The index of value if found in the list; Otherwise, -1.

    IList.Insert(Int32, Object)

    Inserts an item to 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 of the item to be added.

    System.Object value

    The item to be added.

    IList.Item[Int32]

    Gets or sets element at the specified index.

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

    Gets the element at the specified index.

    Returns
    Type Description
    System.Object

    The element at the specified index.

    IList.Remove(Object)

    Removes the item from the collection.

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

    The item to be removed.

    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

    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 - 2021 Syncfusion Inc. All Rights Reserved