Interface ITableEventsTarget

Provides functionalities that handles events raised by Table objects.

Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public interface ITableEventsTarget

Methods

OnCategorizedRecords(TableEventArgs)

Occurs after records are categorized after a table is marked dirty (TableDirty).

Declaration
void OnCategorizedRecords(TableEventArgs e)
Parameters
Type Name Description
TableEventArgs e
Remarks

When TableDirty is set to True, e.g. because schema information for a table was changed or because the grouped columns were changed, the table will categorize records on demand the first time information about a record is accessed. At that time, the EnsureInitialized(Object, Boolean) will start categorization.

OnCategorizingRecords(TableEventArgs)

Occurs before records are categorized after a table is marked dirty (TableDirty).

Declaration
void OnCategorizingRecords(TableEventArgs e)
Parameters
Type Name Description
TableEventArgs e
Remarks

When TableDirty is set to True, e.g. because schema information for a table was changed or because the grouped columns were changed, the table will categorize records on demand the first time information about a record is accessed. At that time, the EnsureInitialized(Object, Boolean) of the Table will start categorization.

OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs)

Occurs before and after the status of the current record was changed. Check the Action of the CurrentRecordContextChangeEventArgs to get information which current record state was changed.

Declaration
void OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs e)
Parameters
Type Name Description
CurrentRecordContextChangeEventArgs e

OnCurrentRecordManagerReset(TableEventArgs)

Occurs when the Reset() method of the CurrentRecordManager was called.

Declaration
void OnCurrentRecordManagerReset(TableEventArgs e)
Parameters
Type Name Description
TableEventArgs e
Remarks

The GridGroupingControl listens to this event and resets any "Current Cell" state when this event was raised.

OnDisplayElementChanged(DisplayElementChangedEventArgs)

After number of visible elements were changed.

Declaration
void OnDisplayElementChanged(DisplayElementChangedEventArgs e)
Parameters
Type Name Description
DisplayElementChangedEventArgs e

OnDisplayElementChanging(DisplayElementChangingEventArgs)

When number of visible elements are changed.

Declaration
void OnDisplayElementChanging(DisplayElementChangingEventArgs e)
Parameters
Type Name Description
DisplayElementChangingEventArgs e

OnExceptionRaised(ExceptionRaisedEventArgs)

Occurs when an unknown exception has been caught while modifying underlying data in the data source.

Declaration
void OnExceptionRaised(ExceptionRaisedEventArgs e)
Parameters
Type Name Description
ExceptionRaisedEventArgs e
Remarks

If necessary, you can re-throw the exception in your event handler.

OnGroupAdded(GroupEventArgs)

Occurs when a new group was added in a table after the table was categorized and when a record was changed. The event does not occur during categorization of the table. See the CategorizedRecords elements to when categorization finished.

Declaration
void OnGroupAdded(GroupEventArgs e)
Parameters
Type Name Description
GroupEventArgs e

OnGroupCollapsed(GroupEventArgs)

Occurs after a group is collapsed.

Declaration
void OnGroupCollapsed(GroupEventArgs e)
Parameters
Type Name Description
GroupEventArgs e

OnGroupCollapsing(GroupEventArgs)

Occurs before a group is collapsed.

Declaration
void OnGroupCollapsing(GroupEventArgs e)
Parameters
Type Name Description
GroupEventArgs e

OnGroupExpanded(GroupEventArgs)

Occurs after a group is expanded.

Declaration
void OnGroupExpanded(GroupEventArgs e)
Parameters
Type Name Description
GroupEventArgs e

OnGroupExpanding(GroupEventArgs)

Occurs before a group is expanded.

Declaration
void OnGroupExpanding(GroupEventArgs e)
Parameters
Type Name Description
GroupEventArgs e

OnGroupRemoving(GroupEventArgs)

Occurs when a group was removed from a table after the table was categorized and when a record was changed. The event does not occur during categorization of the table. See the CategorizedRecords elements to when categorization finished.

Declaration
void OnGroupRemoving(GroupEventArgs e)
Parameters
Type Name Description
GroupEventArgs e

OnGroupSummaryInvalidated(GroupEventArgs)

Occurs when a summary has been marked dirty.

Declaration
void OnGroupSummaryInvalidated(GroupEventArgs e)
Parameters
Type Name Description
GroupEventArgs e
Remarks

The GridGroupingControl listens to this event will force a repaint of the specified summary if it is visible when this event was raised.

OnInvalidatingCounters(TableEventArgs)

Occurs when the InvalidateCounterTopDown(Boolean) of a Table is called and before all counters are marked dirty.

Declaration
void OnInvalidatingCounters(TableEventArgs e)
Parameters
Type Name Description
TableEventArgs e

OnInvalidatingSummaries(TableEventArgs)

Occurs when the InvalidateSummariesTopDown() of a Table is called and before all summaries in that table are marked dirty.

Declaration
void OnInvalidatingSummaries(TableEventArgs e)
Parameters
Type Name Description
TableEventArgs e

OnRecordCollapsed(RecordEventArgs)

Occurs after a record with nested tables is collapsed.

Declaration
void OnRecordCollapsed(RecordEventArgs e)
Parameters
Type Name Description
RecordEventArgs e

OnRecordCollapsing(RecordEventArgs)

Occurs before a record with nested tables is collapsed.

Declaration
void OnRecordCollapsing(RecordEventArgs e)
Parameters
Type Name Description
RecordEventArgs e

OnRecordDeleted(RecordEventArgs)

Occurs after a record is deleted.

Declaration
void OnRecordDeleted(RecordEventArgs e)
Parameters
Type Name Description
RecordEventArgs e

OnRecordDeleting(RecordEventArgs)

Occurs before a record is deleted.

Declaration
void OnRecordDeleting(RecordEventArgs e)
Parameters
Type Name Description
RecordEventArgs e

OnRecordExpanded(RecordEventArgs)

Occurs after a record with nested tables is expanded.

Declaration
void OnRecordExpanded(RecordEventArgs e)
Parameters
Type Name Description
RecordEventArgs e

OnRecordExpanding(RecordEventArgs)

Occurs before a record with nested tables is expanded.

Declaration
void OnRecordExpanding(RecordEventArgs e)
Parameters
Type Name Description
RecordEventArgs e

OnRecordValueChanged(RecordValueChangedEventArgs)

Occurs when a RecordFieldCell cell's value is changed and after Record.SetValue returned.

Declaration
void OnRecordValueChanged(RecordValueChangedEventArgs e)
Parameters
Type Name Description
RecordValueChangedEventArgs e

OnRecordValueChanging(RecordValueChangingEventArgs)

Occurs when a RecordFieldCell cell's value is changed and before Record.SetValue is called.

Declaration
void OnRecordValueChanging(RecordValueChangingEventArgs e)
Parameters
Type Name Description
RecordValueChangingEventArgs e

OnSelectedRecordsChanged(SelectedRecordsChangedEventArgs)

Occurs after the SelectedRecords collection was modified.

Declaration
void OnSelectedRecordsChanged(SelectedRecordsChangedEventArgs e)
Parameters
Type Name Description
SelectedRecordsChangedEventArgs e

OnSelectedRecordsChanging(SelectedRecordsChangedEventArgs)

Occurs before the SelectedRecords collection was modified.

Declaration
void OnSelectedRecordsChanging(SelectedRecordsChangedEventArgs e)
Parameters
Type Name Description
SelectedRecordsChangedEventArgs e

OnSortedItemsInGroup(GroupEventArgs)

Occurs after the records for a group were sorted.

Declaration
void OnSortedItemsInGroup(GroupEventArgs e)
Parameters
Type Name Description
GroupEventArgs e
Remarks

The engine has a built-in optimization for sorting columns that allows it to perform the sorting on an on-demand basis group-by-group. Suppose you have a table with 200 different countries and you change the sort order of the cities. It is not necessary to sort the whole table. Instead, the individual groups can be sorted when they are scrolled into view. SortingItemsInGroup and SortedItemsInGroup events are fired in such case when a specific group was sorted on demand.

If the whole table was set dirty (see TableDirty), then the whole table is simply recategorized. In that case, only a CategorizedElements event is raised but no SortingItemsInGroup event.

OnSortingItemsInGroup(GroupEventArgs)

Occurs before the records for a group are sorted.

Declaration
void OnSortingItemsInGroup(GroupEventArgs e)
Parameters
Type Name Description
GroupEventArgs e
Remarks

The engine has a built-in optimization for sorting columns that allows it to perform the sorting on an on-demand basis group-by-group. Suppose you have a table with 200 different countries and you change the sort order of the cities. It is not necessary to sort the whole table. Instead, the individual groups can be sorted when they are scrolled into view. SortingItemsInGroup and SortedItemsInGroup events are fired in such case when a specific group was sorted on demand.

If the whole table was set dirty (see TableDirty), then the whole table is simply recategorized. In that case, only a CategorizedElements event is raised but no SortingItemsInGroup event.

OnSourceListListChanged(TableListChangedEventArgs)

Occurs before the Table processes the System.ComponentModel.IBindingList.ListChanged event of an attached source list. More detailed SourceListRecordChanged events will be raised after this event.

Declaration
void OnSourceListListChanged(TableListChangedEventArgs e)
Parameters
Type Name Description
TableListChangedEventArgs e
Remarks

The reason for firing this event is to give a programmer a chance to react to an System.ComponentModel.IBindingList.ListChanged event before the engine since there is otherwise no order guaranteed when an IBindingList raises a ListChanged event.

OnSourceListListChangedCompleted(TableListChangedEventArgs)

Occurs after the Table processes the System.ComponentModel.IBindingList.ListChanged event of an attached source list.

Declaration
void OnSourceListListChangedCompleted(TableListChangedEventArgs e)
Parameters
Type Name Description
TableListChangedEventArgs e
Remarks

The reason for firing this event is to give a programmer the chance to react to an System.ComponentModel.IBindingList.ListChanged event right after the engine since there is otherwise no order guaranteed when an IBindingList raises a ListChanged event.

OnSourceListRecordChanged(RecordChangedEventArgs)

Occurs before the Table processes the System.ComponentModel.IBindingList.ListChanged event of an attached source list. More detailed SourceListRecordChanged events will be raised after this event.

Declaration
void OnSourceListRecordChanged(RecordChangedEventArgs e)
Parameters
Type Name Description
RecordChangedEventArgs e
Remarks

The reason for firing this event is to give a programmer chance to react to an System.ComponentModel.IBindingList.ListChanged event before the engine since there is otherwise no order guaranteed when an IBindingList raises a ListChanged event.

OnSourceListRecordChanging(RecordChangedEventArgs)

Occurs when a record in the underlying data source is added, removed, or changed and before the Table is updated with that change.

Declaration
void OnSourceListRecordChanging(RecordChangedEventArgs e)
Parameters
Type Name Description
RecordChangedEventArgs e

OnTableSourceListChanged(TableEventArgs)

Occurs after the data source is replaced.

Declaration
void OnTableSourceListChanged(TableEventArgs e)
Parameters
Type Name Description
TableEventArgs e

Extension Methods