Class FilterBarChoicesSummary
Provides distinct values of a field that can be used in a filter bar.
Inherited Members
Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public sealed class FilterBarChoicesSummary : VectorSummary, ITreeTableSummary, ICountAggregate
Constructors
FilterBarChoicesSummary(Object[], Int32)
Initializes a new instance of FilterBarChoicesSummary class with the specified values.
Declaration
public FilterBarChoicesSummary(object[] values, int length)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object[] | values | Summary values. |
| System.Int32 | length | Number of values. |
Fields
Empty
The initial summary object for empty records or tables.
Declaration
public static readonly FilterBarChoicesSummary Empty
Field Value
| Type |
|---|
| FilterBarChoicesSummary |
Methods
Combine(FilterBarChoicesSummary)
Combines the values of this summary with another summary and returns a new summary object.
Declaration
public FilterBarChoicesSummary Combine(FilterBarChoicesSummary other)
Parameters
| Type | Name | Description |
|---|---|---|
| FilterBarChoicesSummary | other | Another summary object (of the same type). |
Returns
| Type | Description |
|---|---|
| FilterBarChoicesSummary | A new summary object with combined values of both summaries. |
Combine(SummaryBase)
Combines the values of this summary with another summary and returns a new summary object.
Declaration
public override SummaryBase Combine(SummaryBase other)
Parameters
| Type | Name | Description |
|---|---|---|
| SummaryBase | other | Another summary object. |
Returns
| Type | Description |
|---|---|
| SummaryBase | A new summary object with combined values of both summaries. |
Overrides
CreatePageSummaryMethod(SummaryDescriptor, Record)
Used to interface with the page summary.
Declaration
public static ITreeTableSummary CreatePageSummaryMethod(SummaryDescriptor sd, Record record)
Parameters
| Type | Name | Description |
|---|---|---|
| SummaryDescriptor | sd | Summary descriptor. |
| Record | record | Record values. |
Returns
| Type | Description |
|---|---|
| ITreeTableSummary | An instance of the FilterBarChoicesSummary class. |
CreateSummaryMethod(SummaryDescriptor, Record)
Creates a summary object for the specified SummaryDescriptor and record.
Declaration
public static ITreeTableSummary CreateSummaryMethod(SummaryDescriptor sd, Record record)
Parameters
| Type | Name | Description |
|---|---|---|
| SummaryDescriptor | sd | The summary descriptor. |
| Record | record | The record with data. |
Returns
| Type | Description |
|---|---|
| ITreeTableSummary | A new summary object. |