Class GridSummaryColumnDescriptorCollection

Represents a collection of GridSummaryColumnDescriptor which declares the summary columns within a summary row. GridSummaryColumnDescriptor descriptors. An instance of this collection is returned by the SummaryColumns property of a GridSummaryRowDescriptor.

Inheritance

System.Object

GridSummaryColumnDescriptorCollection

Implements

System.IDisposable

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

System.ICloneable

System.ComponentModel.ICustomTypeDescriptor

Namespace: Syncfusion.Windows.Forms.Grid.Grouping

Assembly: Syncfusion.Grid.Grouping.Windows.dll

Syntax

public class GridSummaryColumnDescriptorCollection : Object, IDisposable, IList, ICollection, IEnumerable, ICloneable, ICustomTypeDescriptor

Remarks

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

GridSummaryColumnDescriptorCollection()

Initializes a new instance of the GridSummaryColumnDescriptorCollection class.

Declaration

public GridSummaryColumnDescriptorCollection()

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

InsideCollectionEditor

Gets or sets a value indicating whether the collection was manipulated inside the collection editor or not.

Declaration

public bool InsideCollectionEditor { get; set; }

Property Value

Type
System.Boolean

IsFixedSize

Gets a value indicating whether the collection is fixed size or not. Returns False since this collection has no fixed size.

Declaration

public bool IsFixedSize { get; }

Property Value

Type
System.Boolean

IsReadOnly

Gets a value indicating whether the collection is read-only or not. Returns False.

Declaration

public bool IsReadOnly { get; }

Property Value

Type
System.Boolean

IsSynchronized

Gets a value indicating whether the collection can be synchronized or not. 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 GridSummaryColumnDescriptor this[int index] { get; set; }

Parameters

Type	Name	Description
System.Int32	index

Property Value

Type
GridSummaryColumnDescriptor

Item[String]

Gets or sets the element with the specified name.

Declaration

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

Parameters

Type	Name	Description
System.String	name

Property Value

Type
GridSummaryColumnDescriptor

Version

Gets 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(GridSummaryColumnDescriptor)

Adds a SummaryDescriptor to the end of the collection.

Declaration

public int Add(GridSummaryColumnDescriptor value)

Parameters

Type	Name	Description
GridSummaryColumnDescriptor	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_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(GridSummaryColumnDescriptor[])

Adds multiple elements at the end of the collection.

Declaration

public void AddRange(GridSummaryColumnDescriptor[] summaryColumnDescriptors)

Parameters

Type	Name	Description
GridSummaryColumnDescriptor[]	summaryColumnDescriptors	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 GridSummaryColumnDescriptorCollection Clone()

Returns

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

Contains(GridSummaryColumnDescriptor)

Determines a value indicating whether the element belongs to this collection or not.

Declaration

public bool Contains(GridSummaryColumnDescriptor value)

Parameters

Type	Name	Description
GridSummaryColumnDescriptor	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 a value indicating whether the element with the specified name belongs to this collection or not.

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(GridSummaryColumnDescriptor[], Int32)

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

Declaration

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

Parameters

Type	Name	Description
GridSummaryColumnDescriptor[]	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 a value indicating whether the specified System.Object is equal to the current System.Object or not.

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.

GetEnumerator()

Gets an enumerator for the entire collection.

Declaration

public GridSummaryColumnDescriptorCollectionEnumerator GetEnumerator()

Returns

Type	Description
GridSummaryColumnDescriptorCollectionEnumerator	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()

Overrides and gets 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(GridSummaryColumnDescriptor)

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

Declaration

public int IndexOf(GridSummaryColumnDescriptor value)

Parameters

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

Gets 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(GridSummaryColumnDescriptorCollection)

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

Declaration

public void InitializeFrom(GridSummaryColumnDescriptorCollection other)

Parameters

Type	Name	Description
GridSummaryColumnDescriptorCollection	other	The source collection.

Insert(Int32, GridSummaryColumnDescriptor)

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

Declaration

public void Insert(int index, GridSummaryColumnDescriptor value)

Parameters

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

OnChanged(ListPropertyChangedEventArgs)

Triggered when the Changed event is done.

Declaration

protected virtual void OnChanged(ListPropertyChangedEventArgs e)

Parameters

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

OnChanging(ListPropertyChangedEventArgs)

Triggered when the Changing event is done.

Declaration

protected virtual void OnChanging(ListPropertyChangedEventArgs e)

Parameters

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

Remove(GridSummaryColumnDescriptor)

Removes the specified descriptor element from the collection.

Declaration

public void Remove(GridSummaryColumnDescriptor value)

Parameters

Type	Name	Description
GridSummaryColumnDescriptor	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_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()

Overrides and gets the string representation of the current object.

Declaration

public override string ToString()

Returns

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

Events

Changed

Occurs after a property in a nested element or the collection was 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

System.ComponentModel.ICustomTypeDescriptor