Class SummaryDescriptorCollection

A collection from the SummaryDescriptor that declares summaries for groups in a table. An instance of this collection is returned by the Summaries property of a TableDescriptor.

Inheritance

System.Object

SummaryDescriptorCollection

Implements

System.IDisposable

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

System.ICloneable

Namespace: Syncfusion.Grouping

Assembly: Syncfusion.Grouping.Base.dll

Syntax

public class SummaryDescriptorCollection : Object, IDisposable, IList, ICollection, IEnumerable, ICloneable

Constructors

SummaryDescriptorCollection()

Initializes a new instance for SummaryDescriptorCollectionempty collection.

Declaration

public SummaryDescriptorCollection()

Properties

AnyDescriptorIgnoreRecordFilter

Gets whether any summary descriptor has IgnoreRecordFilterCriteria set to True.

Declaration

public bool AnyDescriptorIgnoreRecordFilter { get; }

Property Value

Type
System.Boolean

Count

Gets the number of elements contained in the collection. The property also ensures that the collection is in sync with the underlying table if changes have been made to the table or the TableDescriptor.

Declaration

public int Count { get; }

Property Value

Type
System.Int32

Remarks

If changes in the TableDescriptor are detected, the method will reinitialize the field descriptors before returning the count.

EmptySummaries

Gets an array of empty ITreeTableSummary objects. For each SummaryDescriptor in this collection, an ISummary is created by calling the SummaryDescriptor.CreateSummary method and passing in NULL as record.

Declaration

public ITreeTableSummary[] EmptySummaries { get; }

Property Value

Type	Description
ITreeTableSummary[]	An array of ISummary objects, one for each SummaryDescriptor in this collection.

InsideCollectionEditor

Gets or sets whether the collection is manipulated inside a collection editor.

Declaration

public bool InsideCollectionEditor { get; set; }

Property Value

Type
System.Boolean

IsFixedSize

Returns False since this collection has no fixed size.

Declaration

public bool IsFixedSize { get; }

Property Value

Type
System.Boolean

IsReadOnly

Returns False.

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 element at the zero-based index.

Declaration

public SummaryDescriptor this[int index] { get; set; }

Parameters

Type	Name	Description
System.Int32	index

Property Value

Type
SummaryDescriptor

Item[String]

Gets or sets the element with the specified name.

Declaration

public SummaryDescriptor this[string name] { get; set; }

Parameters

Type	Name	Description
System.String	name

Property Value

Type
SummaryDescriptor

Version

The version number of this collection. The version is increased each time the collection or an element within the collection is modified.

Declaration

public int Version { get; }

Property Value

Type
System.Int32

Methods

Add(SummaryDescriptor)

Adds a SummaryDescriptor to the end of the collection.

Declaration

public int Add(SummaryDescriptor value)

Parameters

Type	Name	Description
SummaryDescriptor	value	The element 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.

Add(String, String, CreateSummaryDelegate)

Creates a SummaryDescriptor and adds it to the end of the collection.

Declaration

public int Add(string name, string mappingName, CreateSummaryDelegate createSummary)

Parameters

Type	Name	Description
System.String	name	The descriptor name.
System.String	mappingName	The underlying field name on which calculations are based.
CreateSummaryDelegate	createSummary	The static summary method that creates a summary object.

Returns

Type	Description
System.Int32	The zero-based collection index at which the value has been added.

Add(String, String, SummaryType)

Creates a SummaryDescriptor and adds it to the end of the collection.

Declaration

public int Add(string name, string mappingName, SummaryType summaryType)

Parameters

Type	Name	Description
System.String	name	The descriptor name.
System.String	mappingName	The underlying field name on which calculations are based on.
SummaryType	summaryType	The summary type.

Returns

Type	Description
System.Int32	The zero-based collection index at which the value has been added.

add_Changed(ListPropertyChangedEventHandler)

Declaration

public void add_Changed(ListPropertyChangedEventHandler value)

Parameters

Type	Name	Description
ListPropertyChangedEventHandler	value

add_Changing(ListPropertyChangedEventHandler)

Declaration

public void add_Changing(ListPropertyChangedEventHandler value)

Parameters

Type	Name	Description
ListPropertyChangedEventHandler	value

AddRange(SummaryDescriptor[])

Adds multiple elements at the end of the collection.

Declaration

public void AddRange(SummaryDescriptor[] values)

Parameters

Type	Name	Description
SummaryDescriptor[]	values	The array with elements that should be added to the end of the collection. The array and its elements cannot be NULL references (Nothing in Visual Basic).

Clear()

Removes all elements from the collection.

Declaration

public void Clear()

Clone()

Creates a copy of the collection and all its elements.

Declaration

public SummaryDescriptorCollection Clone()

Returns

Type	Description
SummaryDescriptorCollection	A copy of the collection and all its elements.

Contains(SummaryDescriptor)

Determines if the element belongs to this collection.

Declaration

public bool Contains(SummaryDescriptor value)

Parameters

Type	Name	Description
SummaryDescriptor	value	The element 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.

Contains(String)

Determines if the element with the specified name belongs to this collection.

Declaration

public bool Contains(string name)

Parameters

Type	Name	Description
System.String	name	The name of the element to locate in the collection.

Returns

Type	Description
System.Boolean	True if item is found in the collection; otherwise, False.

CopyAllMembersTo(SummaryDescriptorCollection)

Copies all members to another collection.

Declaration

protected void CopyAllMembersTo(SummaryDescriptorCollection coll)

Parameters

Type	Name	Description
SummaryDescriptorCollection	coll	The target collection.

CopyTo(SummaryDescriptor[], Int32)

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

Declaration

public void CopyTo(SummaryDescriptor[] array, int index)

Parameters

Type	Name	Description
SummaryDescriptor[]	array	The one-dimensional array that is the destination of the elements copied from ArrayList. The array must have zero-based indexing.
System.Int32	index	The zero-based index in an array at which copying begins.

CreateSummaries(Element)

Helper routine that loops through all SummaryDescriptors of this collection, calls SummaryDescriptor.CreateSummary(element), and returns all results in an array.

Declaration

public ITreeTableSummary[] CreateSummaries(Element element)

Parameters

Type	Name	Description
Element	element	The element on which ISummary objects should be based.

Returns

Type	Description
ITreeTableSummary[]	An array of ISummary objects, one for each SummaryDescriptor in this collection.

Dispose()

Disposes of the object and collection items.

Declaration

public void Dispose()

Equals(Object)

Determines if the specified object and current object are equal.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	An object to compare.

Returns

Type	Description
System.Boolean	True if both objects are equal.

GetEnumerator()

Returns an enumerator for the entire collection.

Declaration

public SummaryDescriptorCollectionEnumerator GetEnumerator()

Returns

Type	Description
SummaryDescriptorCollectionEnumerator	An Enumerator for the entire collection.

Remarks

Enumerators only allow reading of the data in the collection. Enumerators cannot be used to modify the underlying collection.

GetHashCode()

Serves as a hash function for a particular type.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A hash code for the current object.

IndexOf(SummaryDescriptor)

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

Declaration

public int IndexOf(SummaryDescriptor value)

Parameters

Type	Name	Description
SummaryDescriptor	value	The element 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 element within the entire collection, if found; otherwise, -1.

IndexOf(String)

Searches for the element with the specified name.

Declaration

public int IndexOf(string name)

Parameters

Type	Name	Description
System.String	name	The name of the element to locate in the collection.

Returns

Type	Description
System.Int32	The zero-based index of the occurrence of the element with matching name within the entire collection, if found; otherwise, -1.

InitializeFrom(SummaryDescriptorCollection)

Copies settings from another collection and raises Changing and Changed events if differences to the other collection are detected.

Declaration

public void InitializeFrom(SummaryDescriptorCollection other)

Parameters

Type	Name	Description
SummaryDescriptorCollection	other	The source collection.

InitializeFrom(SummaryDescriptorCollection, Boolean)

Copies settings from another collection and raises Changing and Changed events if differences to the other collection are detected.

Declaration

public void InitializeFrom(SummaryDescriptorCollection other, bool raiseChangeEvents)

Parameters

Type	Name	Description
SummaryDescriptorCollection	other	The source collection.
System.Boolean	raiseChangeEvents	Indicates if change events should be raised.

Insert(Int32, SummaryDescriptor)

Inserts a descriptor element into the collection at the specified index.

Declaration

public void Insert(int index, SummaryDescriptor value)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index at which the element should be inserted.
SummaryDescriptor	value	The element to insert. The value must not be a NULL reference (Nothing in Visual Basic).

OnChanged(ListPropertyChangedEventArgs)

Raises the Changed event.

Declaration

protected virtual void OnChanged(ListPropertyChangedEventArgs e)

Parameters

Type	Name	Description
ListPropertyChangedEventArgs	e	A ListPropertyChangedEventArgs that contains the event data.

OnChanging(ListPropertyChangedEventArgs)

Raises the Changing event.

Declaration

protected virtual void OnChanging(ListPropertyChangedEventArgs e)

Parameters

Type	Name	Description
ListPropertyChangedEventArgs	e	A ListPropertyChangedEventArgs that contains the event data.

Remove(SummaryDescriptor)

Removes the specified descriptor element from the collection.

Declaration

public void Remove(SummaryDescriptor value)

Parameters

Type	Name	Description
SummaryDescriptor	value	The element to remove from the collection. If the value is NULL or the element is not contained in the collection, the method will do nothing.

Remove(String)

Removes the specified descriptor element with the specified name from the collection.

Declaration

public void Remove(string name)

Parameters

Type	Name	Description
System.String	name	The name of the element to remove from the collection. If no element with that name is found in the collection, the method will do nothing.

remove_Changed(ListPropertyChangedEventHandler)

Declaration

public void remove_Changed(ListPropertyChangedEventHandler value)

Parameters

Type	Name	Description
ListPropertyChangedEventHandler	value

remove_Changing(ListPropertyChangedEventHandler)

Declaration

public void remove_Changing(ListPropertyChangedEventHandler value)

Parameters

Type	Name	Description
ListPropertyChangedEventHandler	value

RemoveAt(Int32)

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

ToString()

Returns a string holding the current object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	String representation of the current object.

Events

Changed

Occurs after a property in a nested element or collection is changed.

Declaration

public event ListPropertyChangedEventHandler Changed

Event Type

Type
ListPropertyChangedEventHandler

Changing

Occurs before a property in a nested element or the collection is changed.

Declaration

public event ListPropertyChangedEventHandler Changing

Event Type

Type
ListPropertyChangedEventHandler

Implements

System.IDisposable

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

System.ICloneable