menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GenericTreeTableWithSummary<V> - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GenericTreeTableWithSummary<V>

    Inheritance
    System.Object
    GenericTreeTableWithSummary<V>
    Implements
    ITreeTable
    System.Collections.IList
    System.Collections.ICollection
    System.IDisposable
    System.Collections.Generic.IList<GenericTreeTableWithSummaryEntry<V>>
    System.Collections.Generic.ICollection<GenericTreeTableWithSummaryEntry<V>>
    System.Collections.Generic.IEnumerable<GenericTreeTableWithSummaryEntry<V>>
    System.Collections.IEnumerable
    ISupportInitialize
    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.Windows.Forms.Collections.Generic
    Assembly: Syncfusion.Spreadsheet.Windows.dll
    Syntax
    public class GenericTreeTableWithSummary<V> : ITreeTable, IList, ICollection, IDisposable, IList<GenericTreeTableWithSummaryEntry<V>>, ICollection<GenericTreeTableWithSummaryEntry<V>>, IEnumerable<GenericTreeTableWithSummaryEntry<V>>, IEnumerable, ISupportInitialize
    Type Parameters
    Name
    V

    Constructors

    GenericTreeTableWithSummary(Boolean)

    Initializes a new GenericTreeTableWithSummary<V>.

    Declaration
    public GenericTreeTableWithSummary(bool sorted)
    Parameters
    Type Name Description
    System.Boolean sorted

    Properties

    Comparer

    Gets or sets the comparer used by sorted trees.

    Declaration
    public IComparer Comparer { get; set; }
    Property Value
    Type
    System.Collections.IComparer

    Count

    Gets the number of items contained in the collection.

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

    HasSummaries

    Indicates whether the tree has summaries.

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

    Identifier

    Declaration
    public int Identifier { get; set; }
    Property Value
    Type
    System.Int32

    IsFixedSize

    Gets a value indicating whether the collection has a fixed size.

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

    IsInitializing

    Indicates whether BeginInit was called.

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

    IsReadOnly

    Gets a value indicating whether the collection is 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 item at the zero-based index.

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

    Root

    Gets the root node.

    Declaration
    public ITreeTableNode Root { get; }
    Property Value
    Type
    ITreeTableNode

    Sorted

    Indicates whether thisTree is sorted.

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

    SyncRoot

    Declaration
    public object SyncRoot { get; }
    Property Value
    Type
    System.Object

    Tag

    Declaration
    public object Tag { get; set; }
    Property Value
    Type
    System.Object

    Methods

    Add(GenericTreeTableWithSummaryEntry<V>)

    Adds a value to the end of the collection.

    Declaration
    public int Add(GenericTreeTableWithSummaryEntry<V> item)
    Parameters
    Type Name Description
    GenericTreeTableWithSummaryEntry<V> item

    The item 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.

    AddIfNotExists(Object, GenericTreeTableWithSummaryEntry<V>)

    Declaration
    public GenericTreeTableWithSummaryEntry<V> AddIfNotExists(object key, GenericTreeTableWithSummaryEntry<V> entry)
    Parameters
    Type Name Description
    System.Object key
    GenericTreeTableWithSummaryEntry<V> entry
    Returns
    Type
    GenericTreeTableWithSummaryEntry<V>

    BeginInit()

    Optimizes insertion of many items when thisTree is initialized for the first time.

    Declaration
    public void BeginInit()

    Clear()

    Removes all items from the collection.

    Declaration
    public void Clear()

    Contains(GenericTreeTableWithSummaryEntry<V>)

    Determines if the item belongs to this collection.

    Declaration
    public bool Contains(GenericTreeTableWithSummaryEntry<V> item)
    Parameters
    Type Name Description
    GenericTreeTableWithSummaryEntry<V> item

    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.

    CopyTo(GenericTreeTableWithSummaryEntry<V>[], Int32)

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

    Declaration
    public void CopyTo(GenericTreeTableWithSummaryEntry<V>[] array, int index)
    Parameters
    Type Name Description
    GenericTreeTableWithSummaryEntry<V>[] array

    The one-dimensional array that is the destination of the items 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.

    Declaration
    public void Dispose()

    Dispose(Boolean)

    Dispose the live resources used by the GenericTreeTableWithSummary<V> class.

    Declaration
    protected virtual void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    Dispose the instance, if it is True

    EndInit()

    Ends optimization of insertion of items when thisTree is initialized for the first time.

    Declaration
    public void EndInit()

    FindHighestSmallerOrEqualKey(Object)

    Declaration
    public GenericTreeTableWithSummaryEntry<V> FindHighestSmallerOrEqualKey(object key)
    Parameters
    Type Name Description
    System.Object key
    Returns
    Type
    GenericTreeTableWithSummaryEntry<V>

    FindKey(Object)

    Declaration
    public GenericTreeTableWithSummaryEntry<V> FindKey(object key)
    Parameters
    Type Name Description
    System.Object key
    Returns
    Type
    GenericTreeTableWithSummaryEntry<V>

    GetEnumerator()

    Declaration
    public IEnumerator<GenericTreeTableWithSummaryEntry<V>> GetEnumerator()
    Returns
    Type
    System.Collections.Generic.IEnumerator<GenericTreeTableWithSummaryEntry<V>>

    GetNextEntry(GenericTreeTableWithSummaryEntry<V>)

    Optimized access to a subsequent entry.

    Declaration
    public GenericTreeTableWithSummaryEntry<V> GetNextEntry(GenericTreeTableWithSummaryEntry<V> current)
    Parameters
    Type Name Description
    GenericTreeTableWithSummaryEntry<V> current
    Returns
    Type
    GenericTreeTableWithSummaryEntry<V>

    GetPreviousEntry(GenericTreeTableWithSummaryEntry<V>)

    Optimized access to the previous entry.

    Declaration
    public GenericTreeTableWithSummaryEntry<V> GetPreviousEntry(GenericTreeTableWithSummaryEntry<V> current)
    Parameters
    Type Name Description
    GenericTreeTableWithSummaryEntry<V> current
    Returns
    Type
    GenericTreeTableWithSummaryEntry<V>

    GetSummaries(ITreeTableEmptySummaryArraySource)

    Returns an array of summary objects.

    Declaration
    public ITreeTableSummary[] GetSummaries(ITreeTableEmptySummaryArraySource emptySummaries)
    Parameters
    Type Name Description
    ITreeTableEmptySummaryArraySource emptySummaries
    Returns
    Type
    ITreeTableSummary[]

    IndexOf(GenericTreeTableWithSummaryEntry<V>)

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

    Declaration
    public int IndexOf(GenericTreeTableWithSummaryEntry<V> item)
    Parameters
    Type Name Description
    GenericTreeTableWithSummaryEntry<V> item

    The item 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 item within the entire collection, if found; otherwise -1.

    IndexOfKey(Object)

    Declaration
    public int IndexOfKey(object key)
    Parameters
    Type Name Description
    System.Object key
    Returns
    Type
    System.Int32

    Insert(Int32, GenericTreeTableWithSummaryEntry<V>)

    Inserts an item into the collection at the specified index.

    Declaration
    public void Insert(int index, GenericTreeTableWithSummaryEntry<V> item)
    Parameters
    Type Name Description
    System.Int32 index

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

    GenericTreeTableWithSummaryEntry<V> item

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

    InvalidateSummariesTopDown(Boolean)

    Marks all summaries dirty.

    Declaration
    public void InvalidateSummariesTopDown(bool notifySummariesSource)
    Parameters
    Type Name Description
    System.Boolean notifySummariesSource

    if set to true notify summaries source.

    Remove(GenericTreeTableWithSummaryEntry<V>)

    Removes the specified item from the collection.

    Declaration
    public bool Remove(GenericTreeTableWithSummaryEntry<V> item)
    Parameters
    Type Name Description
    GenericTreeTableWithSummaryEntry<V> item

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

    Returns
    Type
    System.Boolean

    RemoveAt(Int32)

    Removes the item 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 item to remove.

    Explicit Interface Implementations

    ITreeTable.GetNextEntry(ITreeTableEntry)

    Declaration
    ITreeTableEntry ITreeTable.GetNextEntry(ITreeTableEntry current)
    Parameters
    Type Name Description
    ITreeTableEntry current
    Returns
    Type
    ITreeTableEntry

    ITreeTable.GetPreviousEntry(ITreeTableEntry)

    Declaration
    ITreeTableEntry ITreeTable.GetPreviousEntry(ITreeTableEntry current)
    Parameters
    Type Name Description
    ITreeTableEntry current
    Returns
    Type
    ITreeTableEntry

    ICollection<GenericTreeTableWithSummaryEntry<V>>.Add(GenericTreeTableWithSummaryEntry<V>)

    Declaration
    void ICollection<GenericTreeTableWithSummaryEntry<V>>.Add(GenericTreeTableWithSummaryEntry<V> item)
    Parameters
    Type Name Description
    GenericTreeTableWithSummaryEntry<V> item

    ICollection.CopyTo(Array, Int32)

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

    IEnumerable.GetEnumerator()

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

    IList.Add(Object)

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

    IList.Contains(Object)

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

    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)

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

    IList.Insert(Int32, Object)

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

    IList.Item[Int32]

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

    IList.Remove(Object)

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

    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

    ITreeTable
    System.Collections.IList
    System.Collections.ICollection
    System.IDisposable
    System.Collections.Generic.IList<T>
    System.Collections.Generic.ICollection<T>
    System.Collections.Generic.IEnumerable<T>
    System.Collections.IEnumerable
    ISupportInitialize

    Extension Methods

    EnumerableExtensions.Average<TSource>(IEnumerable<TSource>, Func<TSource, Int16>)
    EnumerableExtensions.Average<TSource>(IEnumerable<TSource>, Func<TSource, Nullable<Int16>>)
    EnumerableExtensions.Sum<TSource>(IEnumerable<TSource>, Func<TSource, Int16>)
    EnumerableExtensions.Sum<TSource>(IEnumerable<TSource>, Func<TSource, Nullable<Int16>>)
    EnumerableExtensions.Max<TSource>(IEnumerable<TSource>, Func<TSource, Int16>)
    EnumerableExtensions.Max<TSource>(IEnumerable<TSource>, Func<TSource, Nullable<Int16>>)
    EnumerableExtensions.Min<TSource>(IEnumerable<TSource>, Func<TSource, Int16>)
    EnumerableExtensions.Min<TSource>(IEnumerable<TSource>, Func<TSource, Nullable<Int16>>)
    EnumerableExtensions.OrderBy<T>(IEnumerable<T>, String, Func<String, Object, Object>)
    EnumerableExtensions.OrderByDescending<T>(IEnumerable<T>, String, Func<String, Object, Object>)
    EnumerableExtensions.OrderBy<T>(IEnumerable<T>, String, Func<String, Object, Object>, IComparer<Object>)
    EnumerableExtensions.OrderByDescending<T>(IEnumerable<T>, String, Func<String, Object, Object>, IComparer<Object>)
    EnumerableExtensions.GetElementType(IEnumerable)
    EnumerableExtensions.GetItemPropertyInfo(IEnumerable)
    FunctionalExtensions.ForEach<T>(IEnumerable, Action<T>)
    FunctionalExtensions.ForEach<T>(IEnumerable<T>, Action<T>)
    FunctionalExtensions.ToList<T>(IEnumerable)
    FunctionalExtensions.IterateIndex<T>(IEnumerable<T>, Action<Int32, T>)
    FunctionalExtensions.IterateIndex<T>(IEnumerable<T>, Action<Int32, T>, Int32)
    FunctionalExtensions.Zip<TFirst, TSecond, TResult>(IEnumerable<TFirst>, IEnumerable<TSecond>, Func<TFirst, TSecond, TResult>)
    FunctionalExtensions.Fold<T, U>(IEnumerable<U>, Func<T, U, T>, T)
    FunctionalExtensions.FoldLeft<T, U>(IEnumerable<U>, Func<T, U, T>, T)
    FunctionalExtensions.FoldRight<T, U>(IEnumerable<U>, Func<T, U, T>, T)
    FunctionalExtensions.MoveTo(IList, Int32, Int32)
    FunctionalExtensions.ToObservableCollection<T>(IEnumerable<T>)
    QueryableExtensions.OfQueryable(IEnumerable)
    QueryableExtensions.OfQueryable(IEnumerable, Type)
    QueryableExtensions.GroupByMany<TElement>(IEnumerable, Type, List<Func<TElement, Object>>)
    QueryableExtensions.GroupByMany<TElement>(IEnumerable<TElement>, List<SortDescriptor>, IEnumerable<Func<TElement, Object>>)
    QueryableExtensions.GroupByMany<TElement>(IEnumerable<TElement>, List<SortDescriptor>, Dictionary<String, IComparer<Object>>, String[], IEnumerable<Func<TElement, Object>>)
    QueryableExtensions.GroupByMany<TElement>(IEnumerable<TElement>, List<SortDescriptor>, Dictionary<String, IComparer<Object>>, List<String>, Func<TElement, Object>[])
    QueryableExtensions.GroupByMany<TElement>(IEnumerable<TElement>, List<SortDescriptor>, Func<TElement, Object>[])
    QueryableExtensions.GroupByMany<TElement>(IEnumerable<TElement>, Func<TElement, Object>[])
    QueryableExtensions.GroupByMany<TElement>(IEnumerable<TElement>, IEnumerable<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[])
    PivotExtension.GroupByMany<TElement>(IEnumerable<TElement>, Int32, Func<TElement, Object>[])
    PivotExtension.GroupByMany<TElement>(IEnumerable<TElement>, IEnumerable<Func<TElement, Object>>)
    ChartExtensionUtils.DistinctBy<TSource, TKey>(IEnumerable<TSource>, Func<TSource, TKey>)
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved