WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Namespace Syncfusion.Grouping

    Show / Hide Table of Contents

    Namespace Syncfusion.Grouping

    Classes

    AddNewRecord

    Defines and implements the class that adds a new record element to the underlying data source. This element represents the empty record that is shown above the table records and / or below the records for each group and implements logic to add new records.

    AddNewRecordSection

    Defines a class that adds a new record section to the table.

    BooleanAggregateSummary

    Summarizes Boolean fields. Provides Count, TrueCount, and FalseCount.

    ByteAggregateSummary

    Summarizes Byte fields. Provides Count, Minimum, Maximum, Sum, and Average.

    CaptionRow

    Defines a class that implements the row for the caption bar of a group.

    CaptionRowCollection

    Represents the class that supports a collection of CaptionRow elements that are children of a CaptionSection in a Group. An instance of this collection is returned by the CaptionRows property of a CaptionSection object.

    CaptionRowCollectionEnumerator

    Defines the class for CaptionRow elements of a CaptionRowCollection.

    CaptionSection

    Defines and implements the class that supports the section of the Caption row.

    ChangedFieldInfo

    Implements details about the changes made to a column at the time the ListChanged event is handled in the engine.

    ChangedFieldInfoCollection

    Implements the Collection with detected changes in the data source when a ListChanged event is handled.

    CharAggregateSummary

    Summarizes Byte fields. Provides Count, Minimum, Maximum.

    ChildTable

    Defines a class for ChildTable which is either a TopLevelGroup or a group that can be referenced as nested table from a record in a parent table. ChildTable groups are created for every new key found based on RelationKeys.

    You can get access to a ChildTable through the ChildTable property of a NestedTable in a record.

    CollectionWrapper

    Defines the class that provides a wrapper around System.Collections.ArrayList. It is used to hold a set of non-generic collections.

    CollectionWrapper.CollectionWrapperEnumerator

    Defines the class that serves as enumerator for CollectionWrapper.

    ColumnHeaderRow

    Represents the class that implements the row for the column header row in a group.

    ColumnHeaderRowCollection

    Defines the class that provides the collection of CaptionRow elements that are children of a ColumnHeaderSection in a Group. An instance of this collection is returned by the ColumnHeaderRows property of a ColumnHeaderSection object.

    ColumnHeaderRowCollectionEnumerator

    Defines the class for ColumnHeaderRow elements of a ColumnHeaderRowCollection.

    ColumnHeaderSection

    Defines the class that implements the section of the column headers.

    CompareColumns

    Implements utilities for comparing two records or columns.

    CountSummary

    Counts non-null entries. If SummaryDescriptor.Name is an empty string, records are counted.

    CurrentRecordContextChangeEventArgs

    Represents a class that provides the data for the CurrentRecordContextChange event that occurs before and after the status of the current record is changed. Check the Action to get information on which current record state was changed.

    CurrentRecordManager

    Manages the current record or element in a table and provides routines both for navigation and editing.

    CurrentRecordProperty

    Represents a class to CurrentRecordProperty element provides storage for modified values for the current Record in a CurrentRecordManager. CurrentRecordProperty objects are accessed through the collection returned by the Properties property of a CurrentRecordManager object.

    CurrentRecordPropertyCollection

    Represents a class that provides a collection of CurrentRecordProperty elements that provides storage for modified values for the current Record in a CurrentRecordManager. An instance of this collection is returned by the Properties property of a CurrentRecordManager object.

    CurrentRecordPropertyCollectionEnumerator

    Represents a class to current record property collections that enumerates for CurrentRecordProperty items of a CurrentRecordPropertyCollection.

    CustomCountEventArgs

    Represents the class that provides data for the QueryCustomCount and QueryVisibleCustomCount events that occur when the custom counter value for a record is queried.

    CustomTypeDescriptorConverter

    A ExpandableObjectConverter that lets users expand collections at design-time and list collection items similar to nested properties of a class.

    DataTableColumnPropertyDescriptor

    Represents the class that provides a custom PropertyDescriptor that is used within a DataTableWrapperList to access a DataColumn.

    DataTableList

    Represents a class that provides support for IBindingList that wraps a DataTable and provides optimized access to the rows of the data table.

    DescriptorBase

    Base class for schema definition objects of the grouping engine.

    DescriptorBaseConverter

    The type converter for DescriptorBase objects. DescriptorBaseConverter is a System.ComponentModel.ExpandableObjectConverter. It overrides the default behavior of the ConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type) method and returns the GetName() result of the DescriptorBase object. ConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type) is called from a property grid to determine the name of the object to be displayed.

    DescriptorBasePropertyDescriptor

    A custom PropertyDescriptor that adds design-time support for descriptor collections in the grouping engine. DescriptorBasePropertyDescriptor objects help with adding support for expanding a collection similar to an expandable object in a property grid.

    DescriptorPropertyChangedEventArgs

    Represents the class that provides the data for PropertyChanged or PropertyChanging events which occur when a property is changed.

    DetailsSection

    Defines a base class for the RecordsInDetailsCollection or GroupsInDetailsCollection. Instances of this class are accessed through the Details property of a parent Group.

    Diagnostics

    Internal only. Represents the class that provides the diagnostics methods to trace the element operations.

    DisplayElementChangedEventArgs

    Represents the class that provides data for the DisplayElementChanged event that occurs after display elements in a table are changed. A GridGroupingControl listens to this event and repaints affected elements if necessary.

    DisplayElementChangingEventArgs

    Represents the class that provides data for the DisplayElementChanging event that occurs before display elements in a table are changed. A GridGroupingControl listens to this event and deactivates the current cell and / or saves the cell's contents if necessary.

    DisplayElementsInTableCollection

    Implements a read-only collection of Element objects in a Table which represent a flattened view of grouped and hierarchical records that are visible and meet filter criteria in the data source. An instance of this collection is returned by the DisplayElements property of a Table object.

    This collection does not step into child elements of a NestedTable.

    DistinctCountSummary

    Provides distinct count of a field and a vector with all distinct values of the field.

    DoubleAggregateSummary

    Summarizes System.Double fields. Provides Count, Minimum, Maximum, Sum, and Average.

    DoubleVectorSummary

    Implements to collect all entries of a column in a sorted vector. Provides statistical functions that work on this set such as Median, Percentile25, Percentile75, and PercentileQ.

    DynamicPropertyDescriptor

    A class that provides an abstraction of a dynamic property.

    Element

    Represents the base class for all elements in the grouping engine that represent the grouped structure of an underlying data source.

    ElementsInTableCollection

    Implements a read-only collection Element objects in a Table which represent a flattened view of grouped and hierarchical records. All records are returned no matter if they meet filter criteria or not. An instance of this collection is returned by the Elements property of a Table object.

    This collection does not step into child elements of a NestedTable.

    EmptySection

    Defines a class that implements the empty section with 1 visible element. Can be used as a place holder to appear in DisplayElements. GetYAmountCount will return DefaultEmptySectionHeight of the ParentTable.

    Engine

    Represents the class that provides the engine to set the main data source for the whole engine. The TableDescriptor will pick up the ItemProperties (schema information) from the SourceList and table will be initialized at run-time with records from the list.

    EngineTableDescriptorEnumerable

    For internal use. Represents a class that supports a simple iteration over a non-generic collection to the engine table descriptor.

    EngineTableDescriptorEnumerator

    For internal use. Represents a class that supports the simple iteration over the non-generic collection to engine table descriptor.

    EngineTableEnumerable

    For internal use. Represents a class that supports a simple iteration over a non-generic collection to the engine table.

    EngineTableEnumerator

    For internal use. Represents a class that supports a simple iteration over a non-generic collection to engine table enumerator.

    ExceptionRaisedEventArgs

    Represents the class that provides data for the ExceptionRaised event that occurs when an unknown exception has been cached while modifying underlying data in the data source.

    ExpressionFieldDescriptor

    ExpressionFieldDescriptor is a FieldDescriptor with support for run-time formula expressions.

    Expression fields are managed by the ExpressionFieldDescriptorCollection that is returned by the ExpressionFields property of a TableDescriptor.

    ExpressionFieldDescriptorCollection

    A collection of ExpressionFieldDescriptor fields with run-time formula expressions. An instance of this collection is returned by the ExpressionFields property of a TableDescriptor.

    ExpressionFieldDescriptorCollectionEnumerator

    Enumerator class for the ExpressionFieldDescriptor elements of an ExpressionFieldDescriptorCollection.

    ExpressionFieldDescriptorTypeConverter

    The type converter for ExpressionFieldDescriptor objects. ExpressionFieldDescriptorTypeConverter is an DescriptorBaseConverter. It overrides the default behavior of the ConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type) method and adds support for design-time code serialization.

    ExpressionFieldEvaluator

    Encapsulates the code required to parse and compute formulas. Hash table properties maintain a Formula Library of functions as well as a list of dependent cells.

    You can add and remove library functions.

    FieldDescriptor

    FieldDescriptor provides mapping information to a column of the underlying datasource.

    Fields are managed by the FieldDescriptorCollection that is returned by the Fields property of a TableDescriptor.

    FieldDescriptorCollection

    A collection of FieldDescriptor fields with mapping information to columns of the underlying datasource. An instance of this collection is returned by the Fields property of a TableDescriptor.

    FieldDescriptorCollectionEnumerator

    Enumerator class for FieldDescriptor elements of a FieldDescriptorCollection.

    FieldDescriptorNameComparer

    An IComparer implementation for comparing the names of two FieldDescriptor objects.

    FieldDescriptorTypeConverter

    The type converter for FieldDescriptor objects. FieldDescriptorTypeConverter is a DescriptorBaseConverter. It overrides the default behavior of the ConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type) method and adds support for design-time code serialization.

    FieldValueEventArgs

    Represents the class that provides data for the QueryValue and SaveValue events that occur when a value for a field descriptor and record is returned or when a value for a field descriptor and record is saved.

    FilterBarChoicesSummary

    Provides distinct values of a field that can be used in a filter bar.

    FilterBarRow

    Implements the class that provides a filter bar row.

    FilterBarRowCollection

    Represents the class that provides a collection of FilterBarRow elements that are children of a FilterBarSection in a Group. An instance of this collection is returned by the FilterBarRows property of a FilterBarSection object. (NOTE: FilterBars are not supported in Version 2.0).

    FilterBarRowCollectionEnumerator

    Represents the class that supports a simple iteration for FilterBarRow elements of a FilterBarRowCollection.

    FilterBarSection

    Represents a class that provides a place holder section with 1 visible element for showing a filter bar.

    FilterCondition

    Represents a class for FilterCondition and is a child of a RecordFilterDescriptor with filter criteria for displaying only a subset of records from the underlying datasource. FilterCondition elements are stored in a collection that is returned by the Conditions property of a RecordFilterDescriptor.

    FilterConditionCollection

    Represents a class for collection of FilterCondition that are children of a RecordFilterDescriptor with filter criteria for displaying only a subset of records from the underlying datasource. An instance of this collection is returned by the Conditions property of a RecordFilterDescriptor.

    FilterConditionCollectionEnumerator

    Represents an enumerator class for FilterCondition elements of a FilterConditionCollection class.

    FilterConditionTypeConverter

    Represents a class for type converter for FilterCondition objects. FilterConditionTypeConverter is a DescriptorBaseConverter. It overrides the default behavior of the method and adds support for design-time code serialization.

    FilteredRecordsInDetailsCollection

    A Read-only collection of Record elements that meet filter criteria and are children of a RecordsDetails section. See RecordFilterDescriptorCollection or RecordFilters for filter criteria. An instance of this collection is returned by the FilteredRecords property of a Group object.

    FilteredRecordsInDetailsCollectionEnumerator

    Enumerator class for Record elements of a FilteredRecordsInDetailsCollection.

    FilteredRecordsInTableCollection

    Represents a class that provides the read-only collection of sorted Record elements that meets filter criteria and are children of a Table.

    FlattenedFilteredRecordsInGroupCollection

    A Read-only collection of sorted Record elements that meet filter criteria and are children of a Group. See RecordFilterDescriptorCollection or RecordFilters for filter criteria. An instance of this collection is returned by the FilteredRecords property of a Group object.

    The collection provides support for determining a record's position in the grouped group using the IndexOf(Record) method.

    FlattenedRecordsInGroupCollection

    A Read-only collection of sorted Record elements that are children of a Group. An instance of this collection is returned by the Records property of a Group object. This collection contains all records, it is not filtered.

    The collection provides support for determining a record's position in the grouped group using the IndexOf(Record) method.

    FlattenedRecordsInGroupCollectionBase

    A Read-only collection base class for FlattenedFilteredRecordsInGroupCollection and FlattenedRecordsInGroupCollection.

    FlattenedRecordsInGroupCollectionEnumerator

    Enumerator class for Record elements of a FlattenedRecordsInGroupCollectionBase.

    GetItemPropertiesNameConverter

    A type converter that utilizes the IGetItemProperties interface and provides standard values based on the properties returned by IGetItemProperties.GetItemProperties. These standard values can be dropped down in the PropertyGrid at design-time.

    Group

    Represents the class that provides a group which defines a set of records that belong to a category. A group has multiple sections such as CaptionSection, SummarySection, GroupsDetailsSection, and RecordsDetailsSection.

    GroupEventArgs

    Represents the class that provides data for events that occur on a group level such as GroupCollapsing, GroupCollapsed, GroupExpanding, and GroupExpanded.

    GroupFooterSection

    Defines the class that provides place holder section with 1 visible element for showing a footer below a group in DisplayElements.

    GroupHeaderSection

    Defines a class that provides a place holder section with 1 visible element for showing a header above a group in DisplayElements.

    GroupingCollectionEditor

    Provides a user interface that can edit collections of descriptor elements at design-time.

    GroupingColumnChangeEventArgs

    Represents a class that provides data for the GroupingColumnChanging event.

    GroupingConfig

    Configuration class for the grouping library. In the current version, there are no explicit settings. Adding this component from the toolbar allows you to easily configure your project for grouping support.

    GroupingRowEventArgs

    Represents a class that provides data for the GroupingColumnChanging event.

    GroupPreviewSection

    Defines the class that implements preview section with one visible element for showing a preview below a group in DisplayElements when a group is collapsed.

    GroupsDetails

    Defines the class that provides details section of a group with nested child groups.

    GroupsInDetailsCollection

    A Read-only collection of Group elements that are children of a GroupsDetails section. An instance of this collection is returned by the Groups property of a GroupsDetails object. The Groups property of a Group does also return an instance of this collection if the group's details section contains groups (and not records). Otherwise an empty collection is returned.

    GroupsInDetailsCollectionEnumerator

    Enumerator class for Group elements of a GroupsInDetailsCollection.

    GroupTypedListRecordsCollection

    For internal use. Defines and implements the class that supports to discover and binds the data source.

    Int32AggregateSummary

    Summarizes integer fields. Provides Count, Minimum, Maximum, Sum, and Average.

    MaxLengthSummary

    Summarizes string fields and lets you determine the maximum length of a string in the column.

    NestedTable

    Represents the class that implements the nested table inside a record.

    NestedTablesCollection

    Represents the class that provides a collection of NestedTable elements that are children of a Record. An instance of this collection is returned by the NestedTables property of a Record object. Each NestedTable has a ChildTable that links the record in a parent table to the child records in a related table.

    NestedTablesCollectionEnumerator

    Enumerator class for NestedTable elements of a NestedTablesCollection.

    PassThroughGroupingResult

    A default implementation of the IPassThroughGroupingResult with support for Linq queries. See the LinqGroupBy example.

    PrimaryKeySortedRecordsCollection

    A collection of primaryKeySorted Record elements that are children of a Table and represent the original records in the same order as the underlying data source. The collection provides support for determining a record's underlying position in the datasource using the IndexOf(String) method.

    An instance of this collection is returned by the PrimaryKeySortedRecords property of a Table object.

    PrimaryKeySortedRecordsCollectionEnumerator

    Enumerator class for Record elements of a PrimaryKeySortedRecordsCollection.

    QueryAddRelationEventArgs

    The Engine.QueryAddRelation event affects the autopopulation of the RelationDescriptorCollection.

    It is called for each relation that is found in a DataView. You can set e.Cancel = True to avoid specific relations being added.

    QueryFilterTextEventArgs

    Represents the class that provides data for the event that occurs when the records are filtered through RecordFilterDescriptor.

    QueryRecordMeetsFilterCriteriaEventArgs

    Represents the class that provides data about the QueryRecordMeetsFilterCriteria event which occurs when a record is checked whether it meets filter criteria and should appear visible in the tables DisplayElements.

    QueryShowFieldEventArgs

    The Engine.QueryShowField event affects the auto population of the FieldDescriptorCollection.

    It is called for each field and lets you control at run-time if a specific field should be added to the FieldDescriptorCollection. You can set e.Cancel = True to avoid specific fields being added.

    QueryShowNestedPropertiesFieldsEventArgs

    The Engine.QueryShowNestedPropertiesFields event affects the auto population of the FieldDescriptorCollection.

    It lets you control at run-time if individual fields should be added for every property of a type when a type has nested properties. You can set e.Cancel = True to avoid nested fields being generated for a specific type.

    QueryShowRelationFieldsEventArgs

    The Engine.QueryShowRelationFields event affects the auto population of the FieldDescriptorCollection.

    It is called for each foreign key relation and lets you control at run-time if the related fields of the child table should be added to the FieldDescriptorCollection. You can set e.Cancel = True to avoid specific fields being added.

    Record

    Represents a record with data. Each record in the data source has an associated Record object in the engine. Records are created when the data source is assigned to a table and before it is sorted or filtered. When a new record is inserted in the data source, a Record is created. When the grouping or sorting of a Table changes, all Record elements stay in sync with their underlying record-counterparts in the data source.

    By default, a record will not appear in the DisplayElements. Instead, a record serves as a container of multiple row elements and nested tables.

    RecordChangedEventArgs

    Represents the class that provides data for SourceListRecordChanged and SourceListRecordChanging events that occur when a record in the underlying data source was added, removed, or changed.

    RecordEventArgs

    Represents the class that provides data for events that occur on a record level such as RecordCollapsing, RecordCollapsed, RecordExpanding, and RecordExpanded.

    RecordFilterDescriptor

    Represents a class for RecordFilterDescriptor that provides filter criteria for displaying only a subset of records from the underlying datasource. A filter can be specified through a collection of FilterCondition elements or with a formula expression similar to expressions used in ExpressionFieldDescriptor.

    RecordFilterDescriptors are managed by the RecordFilterDescriptorCollection that is returned by the RecordFilters property of a TableDescriptor.

    RecordFilterDescriptorCollection

    Represents a class for collection of RecordFilterDescriptor with filter criteria for displaying only a subset of records from the underlying datasource. An instance of this collection is returned by the RecordFilters property of a TableDescriptor.

    RecordFilterDescriptorCollectionEnumerator

    Represents an enumerator class for RecordFilterDescriptor elements of a RecordFilterDescriptorCollection.

    RecordFilterDescriptorTypeConverter

    Represents a class for type converter for RecordFilterDescriptor objects. RecordFilterDescriptorTypeConverter is a DescriptorBaseConverter. It overrides the default behavior of the ConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type) method and adds support for design-time code serialization.

    RecordNestedTablesPart

    Represents a class that provides a part of a record with nested tables.

    RecordPart

    Defines an abstract class that implements a part in a record that serves as a container for the RecordRow, RecordPreviewRow, or NestedTable element collections in a record.

    RecordPartInRecordCollection

    A collection of RecordPart elements that are children of a Record. An instance of this collection is returned by the RecordParts property of a Record object.

    RecordPartInRecordCollectionEnumerator

    Enumerator class for RecordPart elements of a RecordPartInRecordCollection.

    RecordPreviewRow

    A RecordPreview row is an optional element shown only in the DisplayElements when a record is collapsed. You get access to this element through the RecordPreviewRows property of a Record.

    RecordPreviewRowCollection

    Implements a collection of RecordPreviewRow elements that are children of a Record. An instance of this collection is returned by the RecordPreviewRows property of a Record object. If enabled, PreviewRows are displayed when a record is collapsed.

    RecordPreviewRowInSectionCollectionEnumerator

    Enumerator class for RecordPreviewRow elements of a RecordPreviewRowCollection.

    RecordPreviewRowsPart

    Implements a part in a record that serves as a container for RecordPreviewRow elements in a record.

    RecordRow

    A Record row is a place-holder element shown in the DisplayElements for each row in a record. Each record can have multiple record rows. You get access to this element through the RecordRows property of a Record.

    RecordRowCollection

    Implements a collection of RecordRow elements that are children of a Record. An instance of this collection is returned by the RecordRows property of a Record object. RecordRows reserve the display area for displaying the fields of a record in a grid or report.

    RecordRowCollectionEnumerator

    Enumerator class for RecordRow elements of a RecordRowCollection.

    RecordRowsPart

    Implements a part in a record that serves as a container for RecordRow elements in a record.

    RecordsDetails

    Defines the class that provides the details section of a group with records.

    RecordsInDetailsCollection

    A Read-only collection of Record elements that are children of a RecordsDetails section. An instance of this collection is returned by the Records property of a RecordsDetails object. The Records property of a Group also returns an instance of this collection if the group's details section contains records (and not groups). Otherwise an empty collection is returned.

    RecordsInDetailsCollectionEnumerator

    Enumerator class for Record elements of a RecordsInDetailsCollection.

    RecordsInTableCollection

    Represents the class that supports read-only collection of sorted Record elements that are children of a Table. An instance of this collection is returned by the Records property of a Table object. This collection contains all records, it is not filtered.

    The collection provides support for determining a record's position in the grouped table using the IndexOf(Record) method.

    RecordsInTableCollectionBase

    Represents the class that supports the read-only collection base class for RecordsInTableCollection and FilteredRecordsInTableCollection.

    RecordsInTableCollectionEnumerator

    Represents a class to records in the table collections that supports the simple iteration over the non-generic collection.

    RecordValueChangedEventArgs

    Represents the class that provides data about the RecordValueChanged event of a Engine which occurs when a RecordFieldCell cell's value is changed and after Record.SetValue returned.

    RecordValueChangingEventArgs

    Represents the class that provides data about the cancel-able RecordValueChanging event of a Engine which occurs when a RecordFieldCell cell's value is changed and before Record.SetValue is called.

    RecordWithValueCache

    Implements the record that shadows values in table and can gives hints which values were changed in ListChanged event. The new GetOldValue method also gives access to the previous value before a change and can be used for calculating the difference between two values.

    RelationChildColumnDescriptor

    A RelationChildColumnDescriptor defines the sort order of a related table which is defined by the child columns in a a master details relation.

    RelationChildColumnDescriptorare managed by the RelationChildColumnDescriptorCollection that is returned by the RelationChildColumns property of a TableDescriptor.

    RelationChildColumnDescriptorCollection

    A collection from RelationChildColumnDescriptor that are children of a TableDescriptor. A RelationChildColumnDescriptor defines the sort order of a related table which is defined by the child columns in a a master details relation.

    An instance of this collection is returned by the RelationChildColumns property of a TableDescriptor.

    RelationChildColumnDescriptorCollectionEnumerator

    Enumerator class for RelationChildColumnDescriptor elements of a RelationChildColumnDescriptorCollection.

    RelationDescriptor

    A RelationDescriptor defines constraints for a relation between two tables and schema information of child tables. RelationDescriptors are managed by the RelationDescriptorCollection which is returned by the Relations property of a TableDescriptor.

    RelationDescriptorCollection

    A collection of RelationDescriptor with constraints for a relation between two tables and schema information of child tables. An instance of this collection is returned by the Relations property of a TableDescriptor.

    RelationDescriptorCollectionEnumerator

    Enumerator class for RelationDescriptor elements of a RelationDescriptorCollection.

    RelationDescriptorNameComparer

    An IComparer implementation for comparing the names of two RelationDescriptor objects.

    RelationDescriptorTypeConverter

    The type converter for RelationDescriptor objects. RelationDescriptorTypeConverter is a DescriptorBaseConverter. It overrides the default behavior of the ConvertTo method and adds support for design-time code serialization.

    RelationKeyDescriptor

    A RelationKeyDescriptor defines the mapping between parent and child columns in a master details relation. RelationKeyDescriptor are managed by the RelationKeyDescriptorCollection which is returned by the RelationKeys property of a RelationDescriptor.

    RelationKeyDescriptorCollection

    A collection of RelationKeyDescriptor that are children of a RelationDescriptor. A RelationKeyDescriptor defines the mapping between parent and child columns in a master details relation. An instance of this collection is returned by the RelationKeys property of a RelationDescriptor.

    RelationKeyDescriptorCollectionEnumerator

    Enumerator class for the RelationKeyDescriptor elements of a RelationKeyDescriptorCollection.

    ResultTypeConverter

    Implements a for the ResultType property in ExpressionFieldDescriptor.

    RowElement

    A base class for elements that can be added to a RowElementCollection in a RowElementsSection.

    RowElementCollection

    A collection of RowElement elements that are children of an IRowElementsContainer. This is a base class for RecordRowCollection, RecordPreviewRowCollection, and other row collections. An instance of this collection is returned by the RowElements property of an IRowElementsContainer object.

    RowElementCollectionEnumerator

    Enumerator class for RowElement elements of a RowElementCollection.

    RowElementsSection

    A base class for sections that can contain one or multiple row elements.

    RuntimeElementsInTableCollection

    Implements a Read-only collection base class for DisplayElementsInTableCollection and ElementsInTableCollection.

    RuntimeElementsInTableCollectionEnumerator

    Enumerator class for Element objects of a DisplayElementsInTableCollection or ElementsInTableCollection .

    Section

    Defines an abstract base class for sections in a group. A group has multiple sections such as CaptionSection, SummarySection, GroupsDetailsSection, and RecordsDetailsSection.

    SectionInGroupCollection

    Implements a collection of Section elements that are children of a Group. An instance of this collection is returned by the Sections property of a Group object.

    SectionInGroupCollectionEnumerator

    Implements enumerator class for Section elements of a SectionInGroupCollection.

    SelectedRecord

    A SelectedRecord class is a wrapper around a Record. It is used to add records to the SelectedRecordsCollection.

    SelectedRecordsChangedEventArgs

    Represents the class that provides the event data for the SelectedRecordsChanged and SelectedRecordsChanging event which occur when the SelectedRecords collection is/was modified.

    SelectedRecordsCollection

    Implements a collection of selected Record elements that are children of a Table.

    SelectedRecordsCollectionEnumerator

    Implements enumerator class for Record elements of a SelectedRecordsCollection.

    SortColumnDescriptor

    A SortColumnDescriptor defines the sort order or grouping of a table. SortColumnDescriptors are managed by the SortColumnDescriptorCollection which is returned by the SortedColumns or GroupedColumns property of a TableDescriptor.

    SortColumnDescriptorCollection

    A collection of SortColumnDescriptor descriptors that define the sort order or grouping of a table. An instance of this collection is returned by the SortedColumns or GroupedColumns property of a TableDescriptor.

    SortColumnDescriptorCollectionEnumerator

    Enumerator class for SortColumnDescriptor elements of a SortColumnDescriptorCollection.

    SortColumnDescriptorTypeConverter

    The type converter for SortColumnDescriptor objects. SortColumnDescriptorTypeConverter is a DescriptorBaseConverter. It overrides the default behavior of the ConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type) method and adds support for design-time code serialization.

    SourceListDescriptor

    Extracts and manages properties schema information from an underlying list and maintains an System.ComponentModel.ItemPropertiesVersion counter that is increased every time the underlying collection of System.ComponentModel.PropertyDescriptor objects is changed.

    SourceListSet

    Implements the collection that is only meant to be initialized at run-time. It does not support design-time. It also does not raise events when it is changed; it should be setup only once after Engine.SetSourceList is called. It listens to the engine.SourceListChanged event and checks if it can get to a "DataSet". If that is the case, then the DataSet.Tables collection is copied over.

    SourceListSetEntry

    Implements the functionalities that provides access to the underlying source lists for entries in the SourceListSet. SourceListSetEntry classes are used by the RelationDescriptor to look up related lists for a parent table at run-time and to determine schema information for the table descriptor of the related table. If the engine's data source is a DataView or DataTable, SourceListSetEntry entries are populated from the DataTable and DataView objects within the DataViewManager or DataSet.

    SourceListSetEnumerator

    Implements the enumerator class for SourceListSetEntry elements of a SourceListSet.

    StandardValuesCollectionConverter

    A type converter that utilizes the IStandardValuesProvider interface and provides standard values based on the names returned by IStandardValuesProvider.GetStandardValues. These standard values can be dropped down in the PropertyGrid at design-time.

    StringAggregateSummary

    Summarizes string fields. Provides Count and MaximumLength.

    SummaryBase

    Implements the ITreeTableSummary interface and should be used as base class for custom summary objects.

    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.

    SummaryDescriptorCollection

    A collection from the SummaryDescriptor that declares summaries for groups in a table. An instance of this collection is returned by the Summaries property of a TableDescriptor.

    SummaryDescriptorCollectionEnumerator

    Enumerator class for SummaryDescriptor elements of a SummaryDescriptorCollection.

    SummaryDescriptorTypeConverter

    The type converter for SummaryDescriptor objects. SummaryDescriptorTypeConverter is a DescriptorBaseConverter. It overrides the default behavior of the ConvertTo method and adds support for design-time code serialization.

    SummarySection

    Implements the summary section with one visible element for showing a summary below a group in DisplayElements. The summary information can be determined by calling GetSummaries(Table, out Boolean) on the Group that this summary section belongs to.

    SyncfusionAllowCancelEventArgs

    Represents the base class for EventArgs with an AllowCancel property.

    Table

    Implements the functionalities that provides a flattened view of grouped and hierarchical records and manages all the records from the underlying source list.

    TableCollection

    Implements a collection of Table elements that are children of a parent Table. An instance of this collection is returned by the RelatedTables property of a Table object. The collection is internally populated from criteria specified with the Relations collection.

    TableCollectionEnumerator

    Enumerator class for Table items of a TableCollection.

    TableDescriptor

    Represents the class that maintains schema information for a table. Collections define fields, expressions, sorted, grouped columns, and related tables.

    TableEventArgs

    Represents the class that provides data for events that occur on a table such as SourceListChanged, CategorizedRecords, CurrentRecordManagerReset, and others.

    TableFieldPropertyDescriptor

    Implements a custom PropertyDescriptor that is used within a GridGroupTypedListRecordsCollection to access a FieldDescriptor.

    TableListChangedEventArgs

    Represents the class that provides the data for the SourceListListChanged event that occurs before the System.ComponentModel.Table processes the System.ComponentModel.IBindingList.ListChanged event of an attached source list. More detailed SourceListRecordChanged events will be raised after this event.

    TableRecordDataPropertyDescriptor

    Implements a custom PropertyDescriptor that is used within a GridGroupTypedListRecordsCollection to access a FieldDescriptor.

    TableRecordIndexPropertyDescriptor

    Implements a custom PropertyDescriptor that is used within a GridGroupTypedListRecordsCollection to access a FieldDescriptor.

    UnboundFieldDescriptorCollection

    A collection of FieldDescriptor fields with unbound fields. An instance of this collection is returned by the UnboundFields property of a TableDescriptor.

    UnsortedRecordsCollection

    Implements a collection of unsorted Record elements that are children of a Table and represent the original records in the same order as the underlying data source. The collection provides support for determining a record's underlying position in the data source. method.

    An instance of this collection is returned by the UnsortedRecords property of a Table object.

    UnsortedRecordsCollectionEnumerator

    Implements enumerator class for Record elements of a UnsortedRecordsCollection.

    VectorSummary

    Implements to collect all entries of a column in a sorted vector.

    Interfaces

    IAverageAggregate

    Provides an Average getter.

    ICountAggregate

    Provides a Count getter.

    ICustomFilter

    Provides a CompareDescriptor(FilterCondition, Record) method when Custom is specified for a FilterCondition.

    IEngineSource

    Provides the GetEngine() method that returns an Engine.

    IExpressionFieldEvaluator

    An interface that binds the formula logic to expression fields in the grouping engine. A default implementation of this interface is part of the grouping engine and there is normally no need to provide your own implementation.

    If you want to customize the formula calculation you need to implement this interface, override the CreateExpressionFieldEvaluator(TableDescriptor) of the Engine class, and create an instance of your implementation in your overridden method of CreateExpressionFieldEvaluator.

    IGetItemProperties

    Provides support for the GetItemProperties() method that returns a System.ComponentModel.PropertyDescriptorCollection.

    IGroupByColumnCategorizer

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

    IGroupingColumnChanging

    Provides the functionality for the IGroupingColumnChanging.

    IGroupingList

    Provides the functionality that implements customized sorting routines for the engine as shown in the Grid / Grouping / GroupingPerf sample.

    IGroupSortOrderComparer

    Defines an interface to be used for the GroupSortOrderComparer of a SortColumnDescriptor. The GetDependantFields method is called from the engine to determine the fields a GroupSortOrder is dependent on. When the engine gets notified of changes from the underlying data source it will loop through the modified fields of a record and see if any of the modified field names matches the names returned by this methods and in such case recalculate the group sort order. GetDependantFields is only called once when the table is initialized and the results array is then internally cached.

    IInsideCollectionEditorProperty

    This interface is used by GroupingCollectionEditor to initialize collection and determine if changes were made inside the collection editor. If changes are detected, the collection will raise Changing and Changed events from within its InitializeFrom(Object) method.

    IListChangedSource

    Provides the functionality of stripped down version of IBindingList. The interface only has the ListChanged event to notify the engine about changes in a bound data source.

    IPassThroughGroupingResult

    Represents an interface for pass through grouping support in the grouping engine. If you assign a data source which implements this interface as data source for the grouping engine, the engine will interact with the data source through this interface and query groups details and nested tables on demand only.

    IRowElementsContainer

    Provides a RowElements property.

    IStandardValuesProvider

    Provides support for the GetStandardValues(PropertyDescriptor) method that returns an array of standard values used by StandardValuesCollectionConverter.

    ISummarySection

    Identifies element as summary section.

    ITableEventsTarget

    Provides functionalities that handles events raised by Table objects.

    ITableProvider

    Provides a Syncfusion.Grouping.GroupingListChangedEvents method that returns a Table

    ITableSource

    Provides a method to access a Table object.

    Enums

    CurrentRecordAction

    Defines the constants that specifies how the current record context changes.

    DisplayElementKind

    Defines the constants that specifies various kinds of elements.

    EngineCounters

    Defines the constants that specifies the counter logic to be used within the engine. If you have large datasource and need support for groups and filtered records you can reduce the memory footprint by selectively disabling counters you do not need in your application. See WithoutCounter for completely disabling counter logic for the RecordsDetails collection and VirtualMode for using the engine in a virtual mode.

    EngineOptimizations

    Defines the constants that specifies the various optimization the engine can use when applicable. These optimizations can be used in combination with EngineCounter setting.

    FilterCompareOperator

    Comparison operator used by FilterCondition.

    FilterLogicalOperator

    Logical operator used by RecordFilterDescriptor.

    GroupingSortBehavior

    Defines the constants that specifies the sort behavior of the table.

    RecordChangedType

    Defines the constants that specifies how the record list had been changed.

    RelationKind

    Various types of relations between two tables:

    SelectedRecordsChangedType

    Defines the constants that specifies the kind of action for SelectedRecordsChangedEventArgs

    ShowRelationFields

    The Engine.ShowRelationField property affects the auto population of the FieldDescriptorCollection.

    It specifies if dependent fields from a related table in a foreign key relation (or related collection) should be added to the main tables FieldDescriptorCollection. You can also control this behavior at run-time with the QueryShowRelationDisplayFields event. Default is ShowRelationFields.ShowDisplayFieldsOnly.

    SummaryType

    Pre-defined summary types to be used in SummaryDescriptor.

    Delegates

    CreateSummaryDelegate

    Create an ISummary object for the given record and SummaryDescriptor.

    CreateSummaryFromElementDelegate

    Create an ISummary object for the given element and SummaryDescriptor.

    CurrentRecordContextChangeEventHandler

    Represents a method that handles an event with CurrentRecordContextChangeEventArgs.

    CustomCountEventHandler

    Represents a method that handles an event with CustomCountEventArgs.

    DescriptorPropertyChangedEventHandler

    Represents a method that handles a PropertyChanged or PropertyChanging event.

    DisplayElementChangedEventHandler

    Represents a method that handles an event with DisplayElementChangedEventArgs.

    DisplayElementChangingEventHandler

    Represents a method that handles an event with DisplayElementChangingEventArgs.

    ExceptionRaisedEventHandler

    Represents a method that handles an event with ExceptionRaisedEventArgs.

    ExpressionFieldEvaluator.LibraryFunction

    Delegate for custom functions used with AddFunction(String, ExpressionFieldEvaluator.LibraryFunction).

    FieldValueEventHandler

    Represents a method that handles an event with FieldValueEventArgs.

    GroupEventHandler

    Represents a method that handles an event with GroupEventArgs.

    GroupingColumnChangeEventHandler

    Handles the GroupingColumnChange event.

    GroupingRowEventHandler

    Handles the GroupingRow event.

    NestedQueryResultsDelegate

    A delegate that allows the PassThroughGroupingResult to call back and retrieve nested tables with totals on demand.

    QueryAddRelationEventHandler

    Represents a method that handles an event with QueryAddRelationEventArgs.

    QueryFilterTextEventHandler

    Represents a method that handles an event with QueryFilterTextEventArgs.

    QueryGroupsDetailsDelegate

    A delegate that allows the PassThroughGroupingResult to call back and retrieve nested groups details on demand.

    QueryRecordMeetsFilterCriteriaEventHandler

    Represents the method that handles QueryRecordMeetsFilterCriteria event.

    QueryShowFieldEventHandler

    Represents a method that handles an event with QueryShowFieldEventArgs.

    QueryShowNestedPropertiesFieldsEventHandler

    Represents a method that handles an event with QueryShowNestedPropertiesFieldsEventArgs.

    QueryShowRelationFieldsEventHandler

    Represents a method that handles an event with QueryShowRelationFieldsEventArgs.

    RecordChangedEventHandler

    Represents a method that handles an event with RecordChangedEventArgs.

    RecordEventHandler

    Represents a method that handles an event with RecordEventArgs.

    RecordValueChangedEventHandler

    Represents a method that handles the RecordValueChanged event of a Engine.

    RecordValueChangingEventHandler

    Represents a method that handles the cancel-able RecordValueChanging event of a Engine.

    SelectedRecordsChangedEventHandler

    Represents a method that handles an event with SelectedRecordsChangedEventArgs.

    TableEventHandler

    Represents a method that handles an event with TableEventArgs.

    TableListChangedEventHandler

    Represents a method that handles an event with TableListChangedEventArgs.

    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved