Class TreeTableWithCounter
A balanced tree with TreeTableWithCounterEntry entries.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.WinForms.GridCommon.Collections
Assembly: Syncfusion.GridCommon.WinForms.dll
Syntax
public class TreeTableWithCounter : TreeTableWithSummary, ITreeTable, IList, ICollection, IEnumerable, IDisposable
Constructors
TreeTableWithCounter(ITreeTableCounter, Boolean)
Initializes a new TreeTableWithCounter.
Declaration
public TreeTableWithCounter(ITreeTableCounter startPos, bool sorted)
Parameters
Type | Name | Description |
---|---|---|
ITreeTableCounter | startPos | |
System.Boolean | sorted |
Properties
Item[Int32]
Gets / sets a TreeTableWithCounterEntry.
Declaration
public TreeTableWithCounterEntry this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index |
Property Value
Type |
---|
TreeTableWithCounterEntry |
ParentCounterSource
Declaration
public ITreeTableCounterSource ParentCounterSource { get; set; }
Property Value
Type |
---|
ITreeTableCounterSource |
Methods
Add(TreeTableWithCounterEntry)
Appends an object.
Declaration
public int Add(TreeTableWithCounterEntry value)
Parameters
Type | Name | Description |
---|---|---|
TreeTableWithCounterEntry | value | The value. |
Returns
Type |
---|
System.Int32 |
Contains(TreeTableWithCounterEntry)
Indicates whether an entry belongs to the tree.
Declaration
public bool Contains(TreeTableWithCounterEntry value)
Parameters
Type | Name | Description |
---|---|---|
TreeTableWithCounterEntry | value | The entry. |
Returns
Type | Description |
---|---|
System.Boolean |
|
CopyTo(TreeTableWithCounterEntry[], Int32)
Copies the elements of this tree to an array.
Declaration
public void CopyTo(TreeTableWithCounterEntry[] array, int index)
Parameters
Type | Name | Description |
---|---|---|
TreeTableWithCounterEntry[] | array | The array. |
System.Int32 | index | The index. |
EndInit()
Ends optimization of insertion of elements when tree is initialized for the first time.
Declaration
public override void EndInit()
Overrides
GetCounterTotal()
Returns the total of all counters in this tree.
Declaration
public ITreeTableCounter GetCounterTotal()
Returns
Type |
---|
ITreeTableCounter |
GetEntryAtCounterPosition(ITreeTableCounter, Int32)
Overloaded. Returns an entry at the specified counter position. A cookie defines the type of counter.
Declaration
public TreeTableWithCounterEntry GetEntryAtCounterPosition(ITreeTableCounter searchPosition, int cookie)
Parameters
Type | Name | Description |
---|---|---|
ITreeTableCounter | searchPosition | The search position. |
System.Int32 | cookie | The cookie. |
Returns
Type |
---|
TreeTableWithCounterEntry |
GetEntryAtCounterPosition(ITreeTableCounter, Int32, Boolean)
Returns an entry at the specified counter position. A cookie defines the type of counter.
Declaration
public TreeTableWithCounterEntry GetEntryAtCounterPosition(ITreeTableCounter searchPosition, int cookie, bool preferLeftMost)
Parameters
Type | Name | Description |
---|---|---|
ITreeTableCounter | 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 |
---|
TreeTableWithCounterEntry |
GetEnumerator()
Returns a strongly typed enumerator.
Declaration
public TreeTableWithCounterEnumerator GetEnumerator()
Returns
Type |
---|
TreeTableWithCounterEnumerator |
GetNextNotEmptyCounterEntry(ITreeTableEntry, 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 ITreeTableEntry GetNextNotEmptyCounterEntry(ITreeTableEntry current, int cookie)
Parameters
Type | Name | Description |
---|---|---|
ITreeTableEntry | current | The current. |
System.Int32 | cookie | The cookie. |
Returns
Type |
---|
ITreeTableEntry |
GetNextVisibleEntry(TreeTableWithCounterEntry)
Returns the next entry in the collection for which CountVisible counter is not empty.
Declaration
public TreeTableWithCounterEntry GetNextVisibleEntry(TreeTableWithCounterEntry current)
Parameters
Type | Name | Description |
---|---|---|
TreeTableWithCounterEntry | current | The current. |
Returns
Type |
---|
TreeTableWithCounterEntry |
GetPreviousNotEmptyCounterEntry(ITreeTableEntry, 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 ITreeTableEntry GetPreviousNotEmptyCounterEntry(ITreeTableEntry current, int cookie)
Parameters
Type | Name | Description |
---|---|---|
ITreeTableEntry | current | The current. |
System.Int32 | cookie | The cookie. |
Returns
Type |
---|
ITreeTableEntry |
GetPreviousVisibleEntry(TreeTableWithCounterEntry)
Returns the previous entry in the collection for which CountVisible counter is not empty.
Declaration
public TreeTableWithCounterEntry GetPreviousVisibleEntry(TreeTableWithCounterEntry current)
Parameters
Type | Name | Description |
---|---|---|
TreeTableWithCounterEntry | current | The current. |
Returns
Type |
---|
TreeTableWithCounterEntry |
GetStartCounterPosition()
Returns the starting counter for this tree.
Declaration
public ITreeTableCounter GetStartCounterPosition()
Returns
Type |
---|
ITreeTableCounter |
IndexOf(TreeTableWithCounterEntry)
Returns the position of an object in the tree.
Declaration
public int IndexOf(TreeTableWithCounterEntry value)
Parameters
Type | Name | Description |
---|---|---|
TreeTableWithCounterEntry | value | The value. |
Returns
Type |
---|
System.Int32 |
Insert(Int32, TreeTableWithCounterEntry)
Inserts a TreeTableWithCounterEntry object at the specified index.
Declaration
public void Insert(int index, TreeTableWithCounterEntry value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The index. |
TreeTableWithCounterEntry | value | The value. |
InvalidateCounterTopDown(Boolean)
Marks all counters dirty.
Declaration
public void InvalidateCounterTopDown(bool notifyCounterSource)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | notifyCounterSource |
Remove(TreeTableWithCounterEntry)
Removes an object from the tree.
Declaration
public bool Remove(TreeTableWithCounterEntry value)
Parameters
Type | Name | Description |
---|---|---|
TreeTableWithCounterEntry | value | The value. |
Returns
Type |
---|
System.Boolean |