menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TableCollection - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class TableCollection

    Implements a collection of Table elements that are children of a parent Table. An instance of this collection is returned by the RelatedTables property of a Table object. The collection is internally populated from criteria specified with the Relations collection.

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

    Constructors

    TableCollection(Table)

    Initializes the new instance of TableCollectionclass that belongs to the specified parent table.

    Declaration
    public TableCollection(Table parentTable)
    Parameters
    Type Name Description
    Table parentTable

    The table this collection belongs to.

    Fields

    Empty

    A Read-only and empty collection.

    Declaration
    public static readonly TableCollection Empty
    Field Value
    Type
    TableCollection

    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
    System.Int32
    Remarks

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

    IsFixedSize

    Returns False since this collection has no fixed size.

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

    IsReadOnly

    Returns True because this collection is always Read-only.

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

    IsSynchronized

    Returns False.

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

    Item[Int32]

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

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

    Item[String]

    Gets the table with the specified name.

    Declaration
    public Table this[string name] { get; }
    Parameters
    Type Name Description
    System.String name
    Property Value
    Type
    Table

    Methods

    Add(Table)

    Adds a table to the end of the collection.

    Declaration
    public int Add(Table value)
    Parameters
    Type Name Description
    Table 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

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

    AddRange(Table[])

    Adds multiple elements at the end of the collection.

    Declaration
    public void AddRange(Table[] tables)
    Parameters
    Type Name Description
    Table[] tables

    The array whose elements should be added to the end of the collection. The array and its elements cannot be NULL references (Nothing in Visual Basic).

    Clear()

    Removes all elements from the collection.

    Declaration
    public void Clear()

    Contains(Table)

    Determines if the element belongs to this collection.

    Declaration
    public bool Contains(Table value)
    Parameters
    Type Name Description
    Table 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.

    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(Table[], Int32)

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

    Declaration
    public void CopyTo(Table[] array, int index)
    Parameters
    Type Name Description
    Table[] 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.

    Dispose()

    Disposes of the object and resets references to objects.

    Declaration
    public void Dispose()

    GetEnumerator()

    Returns an enumerator for the entire collection.

    Declaration
    public TableCollectionEnumerator GetEnumerator()
    Returns
    Type Description
    TableCollectionEnumerator

    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.

    IndexOf(Table)

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

    Declaration
    public int IndexOf(Table value)
    Parameters
    Type Name Description
    Table 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.

    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.

    IndexOfNestedTable(String)

    Searches for the element with the specified name.

    Declaration
    public int IndexOfNestedTable(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, Table)

    Inserts an element into the collection at the specified index.

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

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

    Table value

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

    Remove(Table)

    Removes the specified element from the collection.

    Declaration
    public void Remove(Table value)
    Parameters
    Type Name Description
    Table 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.

    RemoveAt(Int32)

    Removes the element at the specified index of the collection.

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

    The zero-based index of the element to remove.

    SynchronizeWithRelationDescriptor()

    Adds or removes tables from this collection if the table descriptor or relation descriptor is changed.

    Declaration
    public void SynchronizeWithRelationDescriptor()

    Explicit Interface Implementations

    ICollection.CopyTo(Array, Int32)

    Copies the elements of the collection to an array, starting at a particular System.Array index.

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

    The one-dimensional zero-index based array that is the destination of the elements copied from collections. indexing.

    System.Int32 index

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

    ICollection.SyncRoot

    Gets an object that can be used to synchronize access to the System.Collections.ICollection.

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

    IEnumerable.GetEnumerator()

    Returns an enumerator that iterates through a collection.

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

    A System.Collections.IEnumerator object that can be used to iterate through the collection.

    IList.Add(Object)

    Adds an item to the collection.

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

    The object to be added to the collection.

    Returns
    Type Description
    System.Int32

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

    IList.Contains(Object)

    Determines whether the collection contains a specific value or not.

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

    The object to be located in the collection.

    Returns
    Type Description
    System.Boolean

    true if the System.Object is found 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
    System.Object

    IList.IndexOf(Object)

    Determines the index of a specific item in the collection or not.

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

    The object 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 at which value should be inserted.

    System.Object value

    The object to insert into the System.Collections.IList.

    IList.Item[Int32]

    Gets or sets the element at the specified index.

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

    The zero-based index of the element to get or set.

    Returns
    Type Description
    System.Object

    The element at the specified index.

    IList.Remove(Object)

    Removes the first occurrence of a specific object from the System.Collections.IList.

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

    The object to remove from the System.Collections.IList.

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