Class GridSummaryRowDescriptorCollection

A collection from GridSummaryRowDescriptor that declares summary rows each with one or multiple GridSummaryColumnDescriptor elements. An instance of this collection is returned by the SummaryRows property of a GridTableDescriptor.

Inheritance

System.Object

GridSummaryRowDescriptorCollection

Implements

System.IDisposable

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

IInsideCollectionEditorProperty

System.ICloneable

System.ComponentModel.ICustomTypeDescriptor

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.Windows.Forms.Grid.Grouping

Assembly: Syncfusion.Grid.Grouping.Windows.dll

Syntax

public class GridSummaryRowDescriptorCollection : IDisposable, IList, ICollection, IEnumerable, IInsideCollectionEditorProperty, ICloneable, ICustomTypeDescriptor

Remarks

The SummaryRows collection contains GridSummaryRowDescriptors. GridSummaryRowDescriptors have a name, title, and collection of summary columns. A GridSummaryRowDescriptor also has a Read-only IsFillRow property. If this property is True, the summary should fill the whole row and not be displayed below individual columns. IsFillRow will return True if any of the GridSummaryColummDescriptors in the SummaryColumns collection is set to GridSummaryStyle.FillRow.

The GridSummaryColummDescriptor defines where to display the column in the row. Essential properties are the name, format, DisplayColum, DataMember, and SummaryType. The multiple GridSummaryColumnDescriptor objects have a name and mapping name that identify the column for which a summary should be calculated for and a SummaryType property that defines the type of calculations to be performed.

Possible SummaryTypes are: Count, BooleanAggregate, ByteAggregate, CharAggregate, DistinctCount, DoubleAggregate, Int32Aggregate, MaxLength, StringAggregate, Vector, DoubleVector, and Custom.

When you specify the SummaryType.Custom type, you need to set the custom method through the CreateSummaryMethod property of the SummaryDescriptor. It is of type CreateSummaryDelegate and is called to create an instance of a summary object. You also need to handle the GridGroupingControl.QueryCustomSummary as demonstrated in the Grid/Grouping/CustomSummaries example.

Each group in the GridTable has a summary section. The summary section has as many rows as there are GridSummaryRowDescriptors that are visible. Each GridSummaryRowDescriptor has a collection of GridSummaryColumnDescriptor columns. The GridSummaryColumnDescriptor defines the GridColumnDescriptor to calculate summary information for the SummaryType and the target column where the summary should be displayed in the grid.

Examples

The following example shows how to set up a summary:

' Setup a integrated summary
Dim sd0 As New GridSummaryColumnDescriptor()
sd0.DataMember = "Quantity"
sd0.DisplayColumn = "Quantity"
sd0.Format = "{Average:#.00}"
sd0.SummaryType = SummaryType.DoubleAggregate
Me.gridGroupingControl1.TableDescriptor.SummaryRows.Add(New GridSummaryRowDescriptor("Row 0", "Average", sd0))

// Setup a integrated summary
GridSummaryColumnDescriptor sd0 = new GridSummaryColumnDescriptor();
sd0.DataMember = "Quantity";
sd0.DisplayColumn = "Quantity";
sd0.Format = "{Average:#.00}";
sd0.SummaryType = SummaryType.DoubleAggregate;
this.gridGroupingControl1.TableDescriptor.SummaryRows.Add(new GridSummaryRowDescriptor("Row 0", "Average", sd0));

Constructors

GridSummaryRowDescriptorCollection()

Initializes a new empty collection.

Declaration

public GridSummaryRowDescriptorCollection()

Properties

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	Description
System.Int32

InsideCollectionEditor

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

Declaration

public bool InsideCollectionEditor { get; set; }

Property Value

Type	Description
System.Boolean

IsFixedSize

Returns False since this collection has no fixed size.

Declaration

public bool IsFixedSize { get; }

Property Value

Type	Description
System.Boolean

IsReadOnly

Returns False.

Declaration

public bool IsReadOnly { get; }

Property Value

Type	Description
System.Boolean

IsSynchronized

Returns False.

Declaration

public bool IsSynchronized { get; }

Property Value

Type	Description
System.Boolean

Item[Int32]

Gets or sets the element at the zero-based index.

Declaration

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

Parameters

Type	Name	Description
System.Int32	index

Property Value

Type	Description
GridSummaryRowDescriptor

Item[String]

Gets or sets the element with the specified name.

Declaration

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

Parameters

Type	Name	Description
System.String	name

Property Value

Type	Description
GridSummaryRowDescriptor

Version

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

Declaration

public int Version { get; }

Property Value

Type	Description
System.Int32

VisibleRowCount

Gets the number of rows that have the Visible property set to True. This is also the number of summary rows that are displayed in the grid for each group.

Declaration

public int VisibleRowCount { get; }

Property Value

Type	Description
System.Int32

Methods

Add(GridSummaryRowDescriptor)

Adds a SummaryDescriptor to the end of the collection.

Declaration

public int Add(GridSummaryRowDescriptor value)

Parameters

Type	Name	Description
GridSummaryRowDescriptor	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.

Clear()

Removes all elements from the collection.

Declaration

public void Clear()

Clone()

Creates a copy of the collection and all its elements.

Declaration

public GridSummaryRowDescriptorCollection Clone()

Returns

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

Contains(GridSummaryRowDescriptor)

Determines if the element belongs to this collection.

Declaration

public bool Contains(GridSummaryRowDescriptor value)

Parameters

Type	Name	Description
GridSummaryRowDescriptor	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.

CopyTo(GridSummaryRowDescriptor[], Int32)

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

Declaration

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

Parameters

Type	Name	Description
GridSummaryRowDescriptor[]	array	The one-dimensional array that is the destination of the elements 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 and collection items.

Declaration

public void Dispose()

Equals(Object)

Determines whether the specified System.Object is equal to the current System.Object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	The System.Object to compare with the current System.Object.

Returns

Type	Description
System.Boolean	true if the specified System.Object is equal to the current System.Object; otherwise, false.

Overrides

System.Object.Equals(System.Object)

GetEnumerator()

Returns an enumerator for the entire collection.

Declaration

public GridSummaryRowDescriptorCollectionEnumerator GetEnumerator()

Returns

Type	Description
GridSummaryRowDescriptorCollectionEnumerator	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.

Overrides

System.Object.GetHashCode()

IndexOf(GridSummaryRowDescriptor)

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

Declaration

public int IndexOf(GridSummaryRowDescriptor value)

Parameters

Type	Name	Description
GridSummaryRowDescriptor	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)

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

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 within the entire collection, if found; otherwise, -1.

InitializeFrom(GridSummaryRowDescriptorCollection)

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

Declaration

public void InitializeFrom(GridSummaryRowDescriptorCollection other)

Parameters

Type	Name	Description
GridSummaryRowDescriptorCollection	other	The source collection.

Insert(Int32, GridSummaryRowDescriptor)

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

Declaration

public void Insert(int index, GridSummaryRowDescriptor value)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index at which the element should be inserted.
GridSummaryRowDescriptor	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.

OnPropertyChanged(DescriptorPropertyChangedEventArgs)

Raises the PropertyChanged event.

Declaration

protected virtual void OnPropertyChanged(DescriptorPropertyChangedEventArgs e)

Parameters

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

OnPropertyChanging(DescriptorPropertyChangedEventArgs)

Raises the PropertyChanging event.

Declaration

protected virtual void OnPropertyChanging(DescriptorPropertyChangedEventArgs e)

Parameters

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

Remove(GridSummaryRowDescriptor)

Removes the specified descriptor element from the collection.

Declaration

public void Remove(GridSummaryRowDescriptor value)

Parameters

Type	Name	Description
GridSummaryRowDescriptor	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 a descriptor element that matches 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 locate in the collection.

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 that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string that represents the current object.

Overrides

System.Object.ToString()

Events

Changed

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

Declaration

public event ListPropertyChangedEventHandler Changed

Event Type

Type	Description
ListPropertyChangedEventHandler

Changing

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

Declaration

public event ListPropertyChangedEventHandler Changing

Event Type

Type	Description
ListPropertyChangedEventHandler

PropertyChanged

Occurs when a property is changed.

Declaration

public event DescriptorPropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
DescriptorPropertyChangedEventHandler

PropertyChanging

Occurs before a property is changed.

Declaration

public event DescriptorPropertyChangedEventHandler PropertyChanging

Event Type

Type	Description
DescriptorPropertyChangedEventHandler

Explicit Interface Implementations

IInsideCollectionEditorProperty.InitializeFrom(Object)

initializes the InsideCollectionEditor form.

Declaration

void IInsideCollectionEditorProperty.InitializeFrom(object other)

Parameters

Type	Name	Description
System.Object	other

ICollection.CopyTo(Array, Int32)

Copies the elements of the System.Collections.ICollection to an System.Array, starting at a particular System.Array index.

Declaration

void ICollection.CopyTo(Array array, int index)

Parameters

Type	Name	Description
System.Array	array	The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ICollection. The System.Array must have zero-based indexing.
System.Int32	index	The zero-based index in array at which copying begins.

ICollection.SyncRoot

Gets an object that can be used to synchronize access to the System.Collections.ICollection.

Declaration

object ICollection.SyncRoot { get; }

Returns

Type	Description
System.Object

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator	An System.Collections.IEnumerator object that can be used to iterate through the collection.

IList.Add(Object)

Adds an item to the System.Collections.IList.

Declaration

int IList.Add(object value)

Parameters

Type	Name	Description
System.Object	value	The object to add to the System.Collections.IList.

Returns

Type	Description
System.Int32	The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection.

IList.Contains(Object)

Determines whether the System.Collections.IList contains a specific value.

Declaration

bool IList.Contains(object value)

Parameters

Type	Name	Description
System.Object	value	The object to locate in the System.Collections.IList.

Returns

Type	Description
System.Boolean	true if the System.Object is found in the System.Collections.IList; otherwise,false.

IList.get_Item(Int32)

Declaration

object IList.get_Item(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.Object

IList.IndexOf(Object)

Determines the index of a specific item in the System.Collections.IList.

Declaration

int IList.IndexOf(object value)

Parameters

Type	Name	Description
System.Object	value	The object to locate in the System.Collections.IList.

Returns

Type	Description
System.Int32	The index of value if found in the list; otherwise, -1.

IList.Insert(Int32, Object)

Inserts an item to the System.Collections.IList at the specified index.

Declaration

void IList.Insert(int index, object value)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index at which value should be inserted.
System.Object	value	The object to insert into the System.Collections.IList.

IList.Item[Int32]

Gets or sets the element at the specified index.

Declaration

object IList.this[] { get; set; }

Parameters

Type	Name	Description
System.Int32	index	The zero-based index of the element to get or set.

Returns

Type	Description
System.Object	The element at the specified index.

IList.Remove(Object)

Removes the first occurrence of a specific object from the System.Collections.IList.

Declaration

void IList.Remove(object value)

Parameters

Type	Name	Description
System.Object	value	The object to remove from the System.Collections.IList.

IList.set_Item(Int32, Object)

Declaration

void IList.set_Item(int index, object value)

Parameters

Type	Name	Description
System.Int32	index
System.Object	value

ICloneable.Clone()

Declaration

object ICloneable.Clone()

Returns

Type	Description
System.Object

Implements

System.IDisposable

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

IInsideCollectionEditorProperty

System.ICloneable

System.ComponentModel.ICustomTypeDescriptor