Class SummaryDescriptor

A SummaryDescriptor declares summaries for groups in a table. SummaryDescriptors are managed by the SortColumnDescriptorCollection which is returned by the Summaries property of a TableDescriptor.

Inheritance

System.Object

ShouldSerializeBasedPersisterType

DescriptorBase

SummaryDescriptor

Implements

System.ComponentModel.ICustomTypeDescriptor

System.IDisposable

System.ICloneable

IStandardValuesProvider

Inherited Members

DescriptorBase.CanResetValue()

DescriptorBase.Dispose()

DescriptorBase.Disposed

DescriptorBase.Disposing

DescriptorBase.InDisposed

DescriptorBase.IsDisposed

DescriptorBase.OnDisposed(EventArgs)

DescriptorBase.Reset()

DescriptorBase.ShouldSerialize()

ShouldSerializeBasedPersisterType.AddNewAttributes(PropertyDescriptor, Attribute[], Int32)

ShouldSerializeBasedPersisterType.CheckAllProperties

ShouldSerializeBasedPersisterType.GetCustomPDC(PropertyDescriptorCollection)

ShouldSerializeBasedPersisterType.GetNewAttributesCount(PropertyDescriptor)

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

System.Object.GetType()

System.Object.MemberwiseClone()

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

Namespace: Syncfusion.Grouping

Assembly: Syncfusion.Grouping.Base.dll

Syntax

public class SummaryDescriptor : DescriptorBase, ICustomTypeDescriptor, IDisposable, ICloneable, IStandardValuesProvider

Constructors

SummaryDescriptor()

Initializes a new instance for SummaryDescriptor class.

Declaration

public SummaryDescriptor()

SummaryDescriptor(String, SummaryType)

Initializes a new instance for SummaryDescriptor class with the specified field (mappingName) in the parent table and summary type.

Declaration

public SummaryDescriptor(string mappingName, SummaryType summaryType)

Parameters

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

SummaryDescriptor(String, String, CreateSummaryDelegate)

Initializes a new instance for SummaryDescriptor class with the specified field (mappingName) in the parent table and a custom summary.

Declaration

public SummaryDescriptor(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 on.
CreateSummaryDelegate	createSummary	The static summary method that creates a summary object.

SummaryDescriptor(String, String, CreateSummaryFromElementDelegate)

Initializes a new instance for SummaryDescriptor class with the specified field (mappingName) in the parent table and a custom summary.

Declaration

public SummaryDescriptor(string name, string mappingName, CreateSummaryFromElementDelegate createSummary)

Parameters

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

SummaryDescriptor(String, String, SummaryType)

Initializes a new instance for SummaryDescriptor class with the specified field (mappingName) in the parent table and summary type.

Declaration

public SummaryDescriptor(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.
SummaryType	summaryType	The summary type.

SummaryDescriptor(String, String, SummaryType, Boolean)

Initializes a new instance for SummaryDescriptor class.

Declaration

public SummaryDescriptor(string name, string mappingName, SummaryType summaryType, bool isPagesummary)

Parameters

Type	Name	Description
System.String	name	Name of the summary
System.String	mappingName	mapping name of the summary
SummaryType	summaryType	type of the summary
System.Boolean	isPagesummary	Represents the Boolean value.

Properties

Collection

Gets the collection this descriptor belongs to.

Declaration

public SummaryDescriptorCollection Collection { get; }

Property Value

Type
SummaryDescriptorCollection

CreateSummaryFromElementMethod

Gets or sets a method that creates ISummary objects for a given element and SummaryDescriptor.

Declaration

public CreateSummaryFromElementDelegate CreateSummaryFromElementMethod { get; set; }

Property Value

Type
CreateSummaryFromElementDelegate

CreateSummaryMethod

Gets or sets a method that creates ISummary objects for a given record and SummaryDescriptor.

Declaration

public CreateSummaryDelegate CreateSummaryMethod { get; set; }

Property Value

Type
CreateSummaryDelegate

FieldDescriptor

Gets the field descriptor found for the MappingName.

Declaration

public FieldDescriptor FieldDescriptor { get; }

Property Value

Type
FieldDescriptor

IgnoreRecordFilterCriteria

Gets or sets a value indicating whether the RecordFilter criteria should be ignored and the summary should be calculated for all records or not.

Declaration

public bool IgnoreRecordFilterCriteria { get; set; }

Property Value

Type
System.Boolean

IsPageLevelSummary

Gets or sets the value of page level summary

Declaration

public bool IsPageLevelSummary { get; set; }

Property Value

Type
System.Boolean

MappingName

Gets or sets the mapping name which identifies a field in the parent table.

Declaration

public string MappingName { get; set; }

Property Value

Type
System.String

Name

Gets or sets the name of this descriptor. This name is used to look up the summary in the SummaryDescriptorCollection.

Declaration

public virtual string Name { get; set; }

Property Value

Type
System.String

SummaryType

Gets or sets the type of summary.

Declaration

public SummaryType SummaryType { get; set; }

Property Value

Type
SummaryType

TableDescriptor

Gets the TableDescriptor that this descriptor belongs to.

Declaration

public TableDescriptor TableDescriptor { get; }

Property Value

Type
TableDescriptor

Methods

Clone()

Creates a copy of this descriptor.

Declaration

public SummaryDescriptor Clone()

Returns

Type	Description
SummaryDescriptor	A copy of this descriptor.

CreateSummary(Element)

Creates an ITreeTableSummary for the specified element.

Declaration

public ITreeTableSummary CreateSummary(Element element)

Parameters

Type	Name	Description
Element	element	The element or record.

Returns

Type	Description
ITreeTableSummary	A new ITreeTableSummary object.

Remarks

If the element is a record and IgnoreRecordFilterCriteria is False, the method checks Record.MeetsFilterCriteria(). If it returns False, an empty summary is returned. In that case the CreateSummary delegate will be called with a NULL object.

Dispose(Boolean)

Releases all resources used by the System.ComponentModel.Component.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	true To release both managed and unmanaged resources; false to release only unmanaged resources.

Overrides

DescriptorBase.Dispose(Boolean)

Remarks

See the documentation for the System.ComponentModel.Component class and its Dispose member.

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 the objects are equal.

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Serves as a hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	Hash code.

Overrides

System.Object.GetHashCode()

GetName()

Returns the descriptor name.

Declaration

public override string GetName()

Returns

Type	Description
System.String	Descriptor name.

Overrides

DescriptorBase.GetName()

GetValue(Record)

Gets the value from the record for the field specified with MappingName. If record is an AddNewRecord, a NULL value is returned. If MappingName is empty, a reference to the underlying record data is returned (good for counting RecordCount).

Declaration

public object GetValue(Record record)

Parameters

Type	Name	Description
Record	record	The record to be evaluated.

Returns

Type	Description
System.Object	The value.

InitializeFrom(SummaryDescriptor)

Initializes this object and copies properties from another object. PropertyChanging and PropertyChanged events are raised for every property that is modified. If both objects are equal, no events are raised.

Declaration

public void InitializeFrom(SummaryDescriptor other)

Parameters

Type	Name	Description
SummaryDescriptor	other	The source object.

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)

Occurs when the PropertyChanging event.

Declaration

protected virtual void OnPropertyChanging(DescriptorPropertyChangedEventArgs e)

Parameters

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

ToString()

Returns a string holding the current object.

Declaration

public override string ToString()

Returns

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

Overrides

DescriptorBase.ToString()

Events

PropertyChanged

Occurs when a property is changed.

Declaration

public event DescriptorPropertyChangedEventHandler PropertyChanged

Event Type

Type
DescriptorPropertyChangedEventHandler

PropertyChanging

Occurs before a property is changed.

Declaration

public event DescriptorPropertyChangedEventHandler PropertyChanging

Event Type

Type
DescriptorPropertyChangedEventHandler

Explicit Interface Implementations

IStandardValuesProvider.GetStandardValues(PropertyDescriptor)

Get the standard values by property descriptor.

Declaration

ICollection IStandardValuesProvider.GetStandardValues(PropertyDescriptor pd)

Parameters

Type	Name	Description
System.ComponentModel.PropertyDescriptor	pd	The property descriptor.

Returns

Type	Description
System.Collections.ICollection	Returns the array list.

ICloneable.Clone()

Declaration

object ICloneable.Clone()

Returns

Type
System.Object

Implements

System.ComponentModel.ICustomTypeDescriptor

System.IDisposable

System.ICloneable

IStandardValuesProvider