Interface IGroupByColumnCategorizer

Implement this interface if you want to implement a custom categorizer.

Namespace: Syncfusion.Grouping

Assembly: Syncfusion.Grouping.Base.dll

Syntax

public interface IGroupByColumnCategorizer

Methods

CompareCategoryKey(SortColumnDescriptor, Boolean, Object, Record)

Determines if this record belongs to the same category as the previous record.

Declaration

int CompareCategoryKey(SortColumnDescriptor column, bool isForeignKey, object category, Record record)

Parameters

Type	Name	Description
SortColumnDescriptor	column	The column descriptor.
System.Boolean	isForeignKey	True if this is a foreign key field.
System.Object	category	The category of the previous record.
Record	record	The record to be evaluated.

Returns

Type	Description
System.Int32	True if this record belongs to the same category; False otherwise.

GetGroupByCategoryKey(SortColumnDescriptor, Boolean, Record)

Return a key for the specified column and record.

Declaration

object GetGroupByCategoryKey(SortColumnDescriptor column, bool isForeignKey, Record record)

Parameters

Type	Name	Description
SortColumnDescriptor	column	The column descriptor.
System.Boolean	isForeignKey	True if this is a foreign key field.
Record	record	The record to be evaluated.

Returns

Type	Description
System.Object	A key identifying the category this record belongs to.

Remarks

When categorizing records, all records are first sorted and then looped through in the order they were sorted. Only neighboring records in that sort order can have the same category key.