FlexGrid for WinForms | ComponentOne
C1.Win.C1FlexGrid Namespace / C1FlexGridBase Class / CustomComparer Property

In This Topic
    CustomComparer Property (C1FlexGridBase)
    In This Topic
    Gets or sets a custom comparer object used by the grid to perform grouping, merging, and searching operations.
    Public Property CustomComparer As IComparer
    public IComparer CustomComparer {get; set;}

    The grid has a default System.Collections.IComparer implementation that is used to compare cells and determine if their contents are equivalent. This implementation is used when merging, grouping, or searching for values (see the AllowMerging property and the Subtotal(AggregateEnum,Int32,Int32,Int32,Int32,String,AggregateFlags) and FindRow(String,Int32,Int32,Boolean,Boolean,Boolean,Boolean) methods).

    The default implementation is case-sensitive and takes leading and trailing blanks into account.

    If you want to merge cells using a case-insensitive comparison or trimming blanks, write a custom class that implements the System.Collections.IComparer interface and assign an instance of it to the grid's CustomComparer property.

    Setting this property to null (Nothing in Visual Basic) restores the default behavior.

    The code below replaces the built-in comparer with a System.Collections.CaseInsensitiveComparer. This causes the Subtotal(AggregateEnum,Int32,Int32,Int32,Int32,String,AggregateFlags) method to group items that differ only in case into the same groups:
    // use case-insensitive comparer
    flex.CustomComparer = new CaseInsensitiveComparer(); 
    // add groups ignoring case
    flex.Subtotal(AggregateEnum.Sum, 0, groupOn, totalOn);
    // restore default (case-sensitive) comparer
    flex.CustomComparer = null;
    See Also