Class GenericTreeTableWithCounter<V, C>

Inheritance
System.Object
GenericTreeTableWithCounter<V, C>
Implements
System.IDisposable
System.Collections.Generic.IList<GenericTreeTableWithCounterEntry<V, C>>
System.Collections.Generic.ICollection<GenericTreeTableWithCounterEntry<V, C>>
System.Collections.Generic.IEnumerable<GenericTreeTableWithCounterEntry<V, C>>
System.Collections.IList
System.Collections.ICollection
System.Collections.IEnumerable
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.WinForms.GridCommon.Collections.Generic
Assembly: Syncfusion.GridCommon.WinForms.dll
Syntax
public class GenericTreeTableWithCounter<V, C> : ITreeTable, IDisposable, IList<GenericTreeTableWithCounterEntry<V, C>>, ICollection<GenericTreeTableWithCounterEntry<V, C>>, IEnumerable<GenericTreeTableWithCounterEntry<V, C>>, IList, ICollection, IEnumerable, ISupportInitialize where V : ITreeTableCounterSource where C : ITreeTableCounter
Type Parameters
Name
V
C

Constructors

GenericTreeTableWithCounter(C, Boolean)

Initializes a new GenericTreeTableWithCounter<V, C>.

Declaration
public GenericTreeTableWithCounter(C startPos, bool sorted)
Parameters
Type Name Description
C startPos
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 GenericTreeTableWithCounterEntry<V, C> this[int index] { get; set; }
Parameters
Type Name Description
System.Int32 index
Property Value
Type
GenericTreeTableWithCounterEntry<V, C>

ParentCounterSource

Declaration
public ITreeTableCounterSource ParentCounterSource { get; set; }
Property Value
Type
ITreeTableCounterSource

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(GenericTreeTableWithCounterEntry<V, C>)

Adds a value to the end of the collection.

Declaration
public int Add(GenericTreeTableWithCounterEntry<V, C> item)
Parameters
Type Name Description
GenericTreeTableWithCounterEntry<V, C> 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, GenericTreeTableWithCounterEntry<V, C>)

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

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(GenericTreeTableWithCounterEntry<V, C>)

Determines if the item belongs to this collection.

Declaration
public bool Contains(GenericTreeTableWithCounterEntry<V, C> item)
Parameters
Type Name Description
GenericTreeTableWithCounterEntry<V, C> 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(GenericTreeTableWithCounterEntry<V, C>[], Int32)

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

Declaration
public void CopyTo(GenericTreeTableWithCounterEntry<V, C>[] array, int index)
Parameters
Type Name Description
GenericTreeTableWithCounterEntry<V, C>[] 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 GenericTreeTableWithCounter<V, C> 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 GenericTreeTableWithCounterEntry<V, C> FindHighestSmallerOrEqualKey(object key)
Parameters
Type Name Description
System.Object key
Returns
Type
GenericTreeTableWithCounterEntry<V, C>

FindKey(Object)

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

GetCounterTotal()

Returns the total of all counters in this tree.

Declaration
public C GetCounterTotal()
Returns
Type
C

GetEntryAtCounterPosition(C, Int32)

Overloaded. Returns an entry at the specified counter position. A cookie defines the type of counter.

Declaration
public GenericTreeTableWithCounterEntry<V, C> GetEntryAtCounterPosition(C searchPosition, int cookie)
Parameters
Type Name Description
C searchPosition

The search position.
System.Int32 cookie

The cookie.
Returns
Type
GenericTreeTableWithCounterEntry<V, C>

GetEntryAtCounterPosition(C, Int32, Boolean)

Returns an entry at the specified counter position. A cookie defines the type of counter.

Declaration
public GenericTreeTableWithCounterEntry<V, C> GetEntryAtCounterPosition(C searchPosition, int cookie, bool preferLeftMost)
Parameters
Type Name Description
C searchPosition

The search position.
System.Int32 cookie

The cookie.
System.Boolean preferLeftMost

Indicates if the leftmost entry should be returned if multiple tree elements have the same searchPosition.
Returns
Type
GenericTreeTableWithCounterEntry<V, C>

GetEnumerator()

Declaration
public IEnumerator<GenericTreeTableWithCounterEntry<V, C>> GetEnumerator()
Returns
Type
System.Collections.Generic.IEnumerator<GenericTreeTableWithCounterEntry<V, C>>

GetNextEntry(GenericTreeTableWithCounterEntry<V, C>)

Optimized access to a subsequent entry.

Declaration
public GenericTreeTableWithCounterEntry<V, C> GetNextEntry(GenericTreeTableWithCounterEntry<V, C> current)
Parameters
Type Name Description
GenericTreeTableWithCounterEntry<V, C> current
Returns
Type
GenericTreeTableWithCounterEntry<V, C>

GetNextNotEmptyCounterEntry(GenericTreeTableWithCounterEntry<V, C>, Int32)

Returns the subsequent entry in the collection for which the specific counter is not empty. A cookie defines the type of counter.

Declaration
public GenericTreeTableWithCounterEntry<V, C> GetNextNotEmptyCounterEntry(GenericTreeTableWithCounterEntry<V, C> current, int cookie)
Parameters
Type Name Description
GenericTreeTableWithCounterEntry<V, C> current

The current.
System.Int32 cookie

The cookie.
Returns
Type
GenericTreeTableWithCounterEntry<V, C>

GetNextVisibleEntry(GenericTreeTableWithCounterEntry<V, C>)

Returns the next entry in the collection for which CountVisible counter is not empty.

Declaration
public GenericTreeTableWithCounterEntry<V, C> GetNextVisibleEntry(GenericTreeTableWithCounterEntry<V, C> current)
Parameters
Type Name Description
GenericTreeTableWithCounterEntry<V, C> current

The current.
Returns
Type
GenericTreeTableWithCounterEntry<V, C>

GetPreviousEntry(GenericTreeTableWithCounterEntry<V, C>)

Optimized access to the previous entry.

Declaration
public GenericTreeTableWithCounterEntry<V, C> GetPreviousEntry(GenericTreeTableWithCounterEntry<V, C> current)
Parameters
Type Name Description
GenericTreeTableWithCounterEntry<V, C> current
Returns
Type
GenericTreeTableWithCounterEntry<V, C>

GetPreviousNotEmptyCounterEntry(GenericTreeTableWithCounterEntry<V, C>, Int32)

Returns the previous entry in the collection for which the specific counter is not empty. A cookie defines the type of counter.

Declaration
public GenericTreeTableWithCounterEntry<V, C> GetPreviousNotEmptyCounterEntry(GenericTreeTableWithCounterEntry<V, C> current, int cookie)
Parameters
Type Name Description
GenericTreeTableWithCounterEntry<V, C> current

The current.
System.Int32 cookie

The cookie.
Returns
Type
GenericTreeTableWithCounterEntry<V, C>

GetPreviousVisibleEntry(GenericTreeTableWithCounterEntry<V, C>)

Returns the previous entry in the collection for which CountVisible counter is not empty.

Declaration
public GenericTreeTableWithCounterEntry<V, C> GetPreviousVisibleEntry(GenericTreeTableWithCounterEntry<V, C> current)
Parameters
Type Name Description
GenericTreeTableWithCounterEntry<V, C> current

The current.
Returns
Type
GenericTreeTableWithCounterEntry<V, C>

GetStartCounterPosition()

Returns the starting counter for this tree.

Declaration
public C GetStartCounterPosition()
Returns
Type
C

GetSummaries(ITreeTableEmptySummaryArraySource)

Returns an array of summary objects.

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

IndexOf(GenericTreeTableWithCounterEntry<V, C>)

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

Declaration
public int IndexOf(GenericTreeTableWithCounterEntry<V, C> item)
Parameters
Type Name Description
GenericTreeTableWithCounterEntry<V, C> 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, GenericTreeTableWithCounterEntry<V, C>)

Inserts an item into the collection at the specified index.

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

The zero-based index at which the item should be inserted.
GenericTreeTableWithCounterEntry<V, C> item

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

InvalidateCounterTopDown(Boolean)

Marks all counters dirty.

Declaration
public void InvalidateCounterTopDown(bool notifyCounterSource)
Parameters
Type Name Description
System.Boolean notifyCounterSource

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(GenericTreeTableWithCounterEntry<V, C>)

Removes the specified item from the collection.

Declaration
public bool Remove(GenericTreeTableWithCounterEntry<V, C> item)
Parameters
Type Name Description
GenericTreeTableWithCounterEntry<V, C> 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<GenericTreeTableWithCounterEntry<V, C>>.Add(GenericTreeTableWithCounterEntry<V, C>)

Declaration
void ICollection<GenericTreeTableWithCounterEntry<V, C>>.Add(GenericTreeTableWithCounterEntry<V, C> item)
Parameters
Type Name Description
GenericTreeTableWithCounterEntry<V, C> 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

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

Extension Methods