Class TreeTableVisibleCounter

A counter that counts objects that are marked "Visible".

Inheritance

System.Object

TreeTableVisibleCounter

Implements

ITreeTableCounter

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)

Namespace: Syncfusion.WinForms.GridCommon.Collections

Assembly: Syncfusion.GridCommon.WinForms.dll

Syntax

public class TreeTableVisibleCounter : ITreeTableCounter

Constructors

TreeTableVisibleCounter(Double)

Initializes a TreeTableVisibleCounter with a specified number of visible elements.

Declaration

public TreeTableVisibleCounter(double visibleCount)

Parameters

Type	Name	Description
System.Double	visibleCount	The visible count.

Fields

Empty

Returns an empty TreeTableVisibleCounter that represents zero visible elements.

Declaration

public static readonly TreeTableVisibleCounter Empty

Field Value

Type
TreeTableVisibleCounter

Properties

Kind

The Counter Kind.

Declaration

public virtual int Kind { get; }

Property Value

Type
System.Int32

Methods

Combine(TreeTableVisibleCounter, Int32)

Combines the counter values of this counter object with the values of another counter object and returns a new counter object.

Declaration

public TreeTableVisibleCounter Combine(TreeTableVisibleCounter other, int cookie)

Parameters

Type	Name	Description
TreeTableVisibleCounter	other	The other.
System.Int32	cookie	The cookie.

Returns

Type
TreeTableVisibleCounter

Compare(TreeTableVisibleCounter, Int32)

Compares this counter with another counter. A cookie can specify a specific counter type.

Declaration

public virtual double Compare(TreeTableVisibleCounter other, int cookie)

Parameters

Type	Name	Description
TreeTableVisibleCounter	other	The other.
System.Int32	cookie	The cookie.

Returns

Type
System.Double

CreateCounter()

Factory method creates a new counter object of the same type as this object.

Declaration

public virtual TreeTableVisibleCounter CreateCounter()

Returns

Type
TreeTableVisibleCounter

GetValue(Int32)

Returns the integer value of the counter. A cookie specifies a specific counter type.

Declaration

public virtual double GetValue(int cookie)

Parameters

Type	Name	Description
System.Int32	cookie	The cookie.

Returns

Type
System.Double

GetVisibleCount()

Returns the visible count.

Declaration

public double GetVisibleCount()

Returns

Type
System.Double

IsEmpty(Int32)

Indicates whether the counter object is empty. A cookie can specify a specific counter type.

Declaration

public virtual bool IsEmpty(int cookie)

Parameters

Type	Name	Description
System.Int32	cookie	The cookie.

Returns

Type	Description
System.Boolean	true if the specified cookie is empty; otherwise, false.

OnCombineCounters(ITreeTableCounter, ITreeTableCounter, Int32)

Called to combine the values of two counter objects. Results are saved back into this counter object. A cookie can filter the operation to a limited set of counter types.

Declaration

protected virtual void OnCombineCounters(ITreeTableCounter x, ITreeTableCounter y, int cookie)

Parameters

Type	Name	Description
ITreeTableCounter	x	The x.
ITreeTableCounter	y	The y.
System.Int32	cookie	The cookie.

ToString()

Returns a System.String that represents the current System.Object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents the current System.Object.

Overrides

System.Object.ToString()

Explicit Interface Implementations

ITreeTableCounter.Combine(ITreeTableCounter, Int32)

Combines one tree object with another and returns the new object.

Declaration

ITreeTableCounter ITreeTableCounter.Combine(ITreeTableCounter other, int cookie)

Parameters

Type	Name	Description
ITreeTableCounter	other	The other.
System.Int32	cookie	The cookie.

Returns

Type
ITreeTableCounter

ITreeTableCounter.Compare(ITreeTableCounter, Int32)

Declaration

double ITreeTableCounter.Compare(ITreeTableCounter other, int cookie)

Parameters

Type	Name	Description
ITreeTableCounter	other
System.Int32	cookie

Returns

Type
System.Double

Implements

ITreeTableCounter