Class 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.

Inheritance

System.Object

TableListChangedEventArgs

Namespace: Syncfusion.Grouping

Assembly: Syncfusion.Grouping.Base.dll

Syntax

public class TableListChangedEventArgs : ListChangedEventArgs

Remarks

The reason for firing this event is to give a programmer the 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.

Constructors

TableListChangedEventArgs(Table, ListChangedType, Int32, PropertyDescriptor)

Initializes a new instance of the TableListChangedEventArgs class.

Declaration

public TableListChangedEventArgs(Table table, ListChangedType listChangedType, int newIndex, PropertyDescriptor propDesc)

Parameters

Type	Name	Description
Table	table	The table object.
System.ComponentModel.ListChangedType	listChangedType	Gets the way that the list changed.
System.Int32	newIndex	Gets the new index of the item in the list.
System.ComponentModel.PropertyDescriptor	propDesc	The PropertyDescriptor describing the item.

TableListChangedEventArgs(Table, ListChangedType, Int32, Int32)

Initializes a new instance of the TableListChangedEventArgs class.

Declaration

public TableListChangedEventArgs(Table table, ListChangedType listChangedType, int newIndex, int oldIndex)

Parameters

Type	Name	Description
Table	table	The table object.
System.ComponentModel.ListChangedType	listChangedType	Gets the way that the list changed.
System.Int32	newIndex	Gets the new index of the item in the list.
System.Int32	oldIndex	Gets the old index of the item in the list.

Properties

NavigateCurrentRecordWhenDeleted

Gets or sets the value indicating whether to navigate or not when the current record is deleted.

Declaration

public bool NavigateCurrentRecordWhenDeleted { get; set; }

Property Value

Type
System.Boolean

Remarks

Lets you specify whether the current record should be moved to the previous visible record when an ItemDeleted notification is received for the current record.

By default, the table deactivates the current record. You can avoid this action and force the record to moved if you set this property to True.

ShouldIgnoreReset

Gets or sets the value indicating whether to ignore the reset value or not.

Declaration

public bool ShouldIgnoreReset { get; set; }

Property Value

Type
System.Boolean

Remarks

If the a ListChangedType.Reset notification should be ignored then you set ShouldIgnoreReset = true the table will not set itself dirty and also not repaint the screen. Normally, a listener on a DataView needs to completely reinitialize itself when ListChangedType.Reset is raised because the underlying data source might have been sorted or otherwise changes. Sometimes however you may want to call CurrencyManager.Reset or call DataTable.AcceptChanges without reinitializing the grid. In such case this property will help you avoid delays. The default value for ShouldIgnoreReset is false.

There is an exception when the grid will always handle the Reset event and ignores this setting when the grid detects that the record count it has cached differs from the record count of the underlying source list. In that case the table must be marked dirty to avoid the data and the table to go out of sync.

ShouldInvalidateCounters

Gets or sets the value that indicates whether to resets the counters or not.

Declaration

public bool ShouldInvalidateCounters { get; set; }

Property Value

Type
System.Boolean

Remarks

When specified as counters need to be marked dirty when a ListChanged event is handled. By default, the table does not know whether fields that are changes in a record will affect the counter logic and therefore will always mark all counters dirty from the bottom up. This has performance implications for the next time you need position information about a record (or simply when you call InvalidateRange and the YAmount counter is accessed).

When counters are not marked dirty, subsequent operations that need record position or y-amount position will be much faster. Counters only need to be marked dirty when there is a chance that the sort order is affected or if filter / hidden state of a record is affected or if custom counters are used.

ShouldInvalidateGroupSortOrder

Gets or sets the value indicating whether to reset the group sort order or not.

Declaration

public bool ShouldInvalidateGroupSortOrder { get; set; }

Property Value

Type
System.Boolean

Remarks

Lets you specify if changes to the current record affect the sort order of the parent group

This property only has an affect when a record is changed and you have specified a SortColumnDescriptor.GroupSortOrderComparer for the grouped column, e.g. if you want groups to be sorted by the value of a summary column.

If you know that changes to a specific record won't affect the sort order you can avoid unnecessary resorting of the parent group by setting this property to false.

ShouldInvalidateScreen

Gets or sets the value indicating whether to resets the screen or not.

Declaration

public bool ShouldInvalidateScreen { get; set; }

Property Value

Type
System.Boolean

Remarks

Specified if the grid should repaint the record when changes to the record were made in the underlying data source and a ListChangedType.ItemChanged notification was raised. The default value for ShouldInvalidateScreen is true.

ShouldInvalidateSummaries

Gets or sets the value indicating whether to reset the summaries or not.

Declaration

public bool ShouldInvalidateSummaries { get; set; }

Property Value

Type
System.Boolean

Remarks

specified whether summaries need to be marked dirty when a ListChanged event is handled. By default, the table does not know whether fields that are changed in a record will affect the summaries logic and therefore will always mark all summaries dirty from the bottom up.

ShouldReevaluateSortPosition

Gets or set the value indicating whether to re-evaluate the sort position or not.

Declaration

public bool ShouldReevaluateSortPosition { get; set; }

Property Value

Type
System.Boolean

Remarks

Lets you specify if changes to the current record affect the sort position of the record.

Set this property if you sorted or grouped by an expression field that is dependent on changes in other values of the record. The engine does not track dependencies among fields.

ShouldResetCurrentRecord

Gets or sets a value indicating whether to reset the current record or not.

Declaration

public bool ShouldResetCurrentRecord { get; set; }

Property Value

Type
System.Boolean

Remarks

Lets you specify whether the current record should be reset when an ItemChanged notification is received for the current record. By default, the table resets the current record, but you can avoid this action if you set this property to False.

Table

Gets or sets the value of the Table instance.

Declaration

[TraceProperty(true)]
public Table Table { get; set; }

Property Value

Type
Table

Methods

Create(Table, ListChangedType, Int32, Int32, PropertyDescriptor)

Creates an instance of the TableListChangedEventArgs class.

Declaration

public static TableListChangedEventArgs Create(Table table, ListChangedType listChangedType, int newIndex, int oldIndex, PropertyDescriptor propDesc)

Parameters

Type	Name	Description
Table	table	The table object.
System.ComponentModel.ListChangedType	listChangedType	Gets the way that the list changed.
System.Int32	newIndex	Gets the new index of the item in the list.
System.Int32	oldIndex	Gets the old index of the item in the list.
System.ComponentModel.PropertyDescriptor	propDesc	The PropertyDescriptor describing the item.

Returns

Type	Description
TableListChangedEventArgs	The instance of the TableListChangedEventArgs class.