Class DistanceCounterSubset
A collection of entities that is shared with a parent collection for which distances need to counted. The collection only is a subset for a specific range in the parent distance collection.
When you change the size of an element in this collection the change will also be reflected in the parent collection and vice versa.
Inheritance
Namespace: Syncfusion.GridCommon.ScrollAxis
Assembly: Syncfusion.GridCommon.Portable.dll
Syntax
public class DistanceCounterSubset : Object, IDistanceCounterCollection, IDistancesHost, IDisposableConstructors
DistanceCounterSubset(IDistanceCounterCollection)
Initializes a new instance of the DistanceCounterSubset class.
Declaration
public DistanceCounterSubset(IDistanceCounterCollection trackedParentCollection)Parameters
| Type | Name | Description |
|---|---|---|
| IDistanceCounterCollection | trackedParentCollection | The parent collection for which a subset is "tracked". |
Properties
Count
Gets or sets the raw number of entities (lines, rows or columns).
Declaration
public int Count { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The raw number of entities (lines, rows or columns). |
DefaultDistance
Gets or sets the default distance (row height or column width) an entity spans.
Declaration
public double DefaultDistance { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default distance (row height or column width) an entity spans. |
Distances
Gets an distance the Distances property.
Declaration
protected IDistanceCounterCollection Distances { get; }Property Value
| Type |
|---|
| IDistanceCounterCollection |
End
Gets the ending index of this collection in the parent collection.
Declaration
public int End { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The ending index of this collection in the parent collection. |
Item[Int32]
Gets or sets the distance for an entity from the given index.
Declaration
public double this[int index] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The index for the entity |
Property Value
| Type | Description |
|---|---|
| System.Double | The distance for an entity from the given index. |
Start
Gets or sets the starting index of this collection in the parent collection.
Declaration
public int Start { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The starting index of this collection in the parent collection. |
TotalDistance
Gets the total distance all entities span (e.g. total height of all rows in grid).
Declaration
public double TotalDistance { get; }Property Value
| Type | Description |
|---|---|
| System.Double | The total distance all entities span (e.g. total height of all rows in grid). |
Methods
Clear()
Restores the distances in the parent collection for this subset to their default distance.
Declaration
public void Clear()ConnectWithParent(ITreeTableCounterSource)
This method is not supported for DistanceCounterSubset.
Declaration
protected void ConnectWithParent(ITreeTableCounterSource treeTableCounterSource)Parameters
| Type | Name | Description |
|---|---|---|
| Syncfusion.GridCommon.ITreeTableCounterSource | treeTableCounterSource | The nested tree table visible counter source. |
Dispose()
Releases the managed and unmanaged resources.
Declaration
public void Dispose()Dispose(Boolean)
Releases the unmanaged resources used by the component and optionally releases the managed resources.
Declaration
protected virtual void Dispose(bool disposing)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disposing | if true - release both managed and unmanaged resources; if false - release only unmanaged resources. |
GetAlignedScrollValue(Double)
Gets the aligned scroll value which is the starting point of the entity found at the given distance position.
Declaration
public double GetAlignedScrollValue(double point)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | point | The point. |
Returns
| Type | Description |
|---|---|
| System.Double | The starting point of the entity found at the given distance position. |
GetCumulatedDistanceAt(Int32)
Gets the cumulated count of previous distances for the entity at the specific index. (e.g. return pixel position for a row index).
Declaration
public double GetCumulatedDistanceAt(int index)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The entity index. |
Returns
| Type | Description |
|---|---|
| System.Double | The cumulated count of previous distances for the entity at the specific index. |
GetNestedDistances(Int32)
Gets the nested entities at a given index. If the index does not hold a nested distances collection the method returns null.
Declaration
public IDistanceCounterCollection GetNestedDistances(int index)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The index. |
Returns
| Type | Description |
|---|---|
| IDistanceCounterCollection | The nested entities at a given index or null. |
GetNextScrollValue(Double)
Gets the distance position of the next entity after a given point.
Declaration
public double GetNextScrollValue(double point)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | point | The point after which the next entity is to be found. |
Returns
| Type | Description |
|---|---|
| System.Double | The distance position of the next entity after a given point. |
GetNextVisibleIndex(Int32)
Gets the next visible index. Skip subsequent entities for which the distance is 0.0 and return the next entity.
Declaration
public int GetNextVisibleIndex(int index)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The next visible index from the given index. |
GetPreviousScrollValue(Double)
Gets the distance position of the entity preceding a given point. If the point is in between entities, the starting point of the matching entity is returned.
Declaration
public double GetPreviousScrollValue(double point)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | point | The point of the entity preceding a given point. |
Returns
| Type | Description |
|---|---|
| System.Double | The distance position of the entity preceding a given point. |
GetPreviousVisibleIndex(Int32)
Gets the previous visible index. Skip previous entities for which the distance is 0.0 and return the previous entity.
Declaration
public int GetPreviousVisibleIndex(int index)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The previous visible index from the given index. |
IndexOfCumulatedDistance(Double)
Gets the index of an entity in this collection for which the cumulated count of previous distances is greater than or equal to the specified cumulatedDistance. (e.g. return row index for pixel position).
Declaration
public int IndexOfCumulatedDistance(double cumulatedDistance)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | cumulatedDistance | The cumulated count of previous distances. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The index of an entity in this collection for which the cumulated count of previous distances is greater than or equal to the specified cumulatedDistance. |
Insert(Int32, Int32)
Inserts entities in the collection from the given index.
Declaration
public void Insert(int insertAt, int count)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | insertAt | The index of the first entity to be inserted. |
| System.Int32 | count | The number of entities to be inserted. |
Remove(Int32, Int32)
Removes entities in the collection from the given index.
Declaration
public void Remove(int removeAt, int count)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | removeAt | Index of the first entity to be removed. |
| System.Int32 | count | The number of entities to be removed. |
ResetRange(Int32, Int32)
Resets the range by restoring the default distance for all entries in the specified range.
Declaration
public void ResetRange(int from, int to)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | from | The index for the first entity. |
| System.Int32 | to | The raw index for the last entity. |
SetNestedDistances(Int32, IDistanceCounterCollection)
Assigns a collection with nested entities to an item.
Declaration
public void SetNestedDistances(int index, IDistanceCounterCollection nestedCollection)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The index. |
| IDistanceCounterCollection | nestedCollection | The nested collection. |
SetRange(Int32, Int32, Double)
Hides a specified range of entities (lines, rows or columns).
Declaration
public void SetRange(int from, int to, double distance)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | from | The index for the first entity. |
| System.Int32 | to | The raw index for the last entity. |
| System.Double | distance | The distance. |
Explicit Interface Implementations
IDistanceCounterCollection.ConnectWithParent(ITreeTableCounterSource)
This method is not supported for DistanceCounterSubset.
Declaration
void IDistanceCounterCollection.ConnectWithParent(ITreeTableCounterSource treeTableCounterSource)Parameters
| Type | Name | Description |
|---|---|---|
| Syncfusion.GridCommon.ITreeTableCounterSource | treeTableCounterSource | The nested tree table visible counter source. |
IDistancesHost.Distances
Gets an object that implements the Distances property.
Declaration
IDistanceCounterCollection IDistancesHost.Distances { get; }Returns
| Type |
|---|
| IDistanceCounterCollection |