Class GridTableBase
Implements the class that manages all the records from the underlying source list. The source list can be any IList collection. If it implements IBindingList the GridTable will listen to the ListChangedEvent and update its internal data whenever changes are made to the source list.
Inherited Members
Namespace: Syncfusion.Windows.Forms.Grid.Grouping
Assembly: Syncfusion.Grid.Grouping.Windows.dll
Syntax
public class GridTableBase : Table, IDisposedEvent, IIsDisposedProperty, ITreeTableCounterSource, ITreeTableSummaryArraySource, IContainerElement, IElementTreeTableSource, IElement, IDisposable
Remarks
See the Table class for a more detailed overview about this class.
GridTableBase add support for the Windows Forms CurrencyManager. It detects when the CurrencyManager.Position is changed.
GridTableBase also makes the IBindingList.ListChanged event thread-safe. When rows are added on a different thread, the event is marshaled onto the current UI thread before it is processed.
Constructors
GridTableBase(TableDescriptor, Table)
Initializes a new instance of the GridTableBase class with the specified instances of the TableDescriptor and Table classes that belongs to a parent table.
Declaration
public GridTableBase(TableDescriptor tableDescriptor, Table relationParentTable)
Parameters
Type | Name | Description |
---|---|---|
TableDescriptor | tableDescriptor | The table descriptor with schema information about the table. |
Table | relationParentTable | The parent table of this table; NULL if this table is not a child table of a relation. |
Properties
BindingContext
Gets or sets the BindingContext for the grouping grid.
Declaration
public BindingContext BindingContext { get; set; }
Property Value
Type |
---|
System.Windows.Forms.BindingContext |
Remarks
The BindingContext object of a Control is used to return a single BindingManagerBase object for all data-bound controls contained by the Control. The BindingManagerBase object keeps all controls that are bound to the same data source synchronized. For example, setting the Position property of the BindingManagerBase specifies the item in the underlying list that all data-bound controls point to.
For more information about creating a new BindingContext and assigning it to the BindingContext property, see the BindingContext.
Methods
bindingList_ListChanged(Object, ListChangedEventArgs)
Overrides and raises the Table event is done.
Declaration
protected override void bindingList_ListChanged(object sender, ListChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The Control. |
System.ComponentModel.ListChangedEventArgs | e | An System.ComponentModel.ListChangedEventArgs contains the event data. |
Overrides
Dispose(Boolean)
Overrides and manages the resources.
Declaration
protected override void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disposing |
Overrides
dt_RowDeleting(Object, DataRowChangeEventArgs)
Raises the event.
Declaration
protected override void dt_RowDeleting(object sender, DataRowChangeEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | The Control. |
System.Data.DataRowChangeEventArgs | e | An System.Data.DataRowChangeEventArgs that contains the event data. |
Overrides
GetCurrencyManager()
Gets the CurrencyManager for the assigned SourceList.
Declaration
public CurrencyManager GetCurrencyManager()
Returns
Type | Description |
---|---|
System.Windows.Forms.CurrencyManager | Currency manager. |
GetInvokeRequiredControl()
Determines if the current thread is the same UI thread as the parent control or if the current method call should be marshaled.
Declaration
protected virtual Control GetInvokeRequiredControl()
Returns
Type | Description |
---|---|
System.Windows.Forms.Control | A control that can be used to marshal the current method by calling its Invoke method. |
Remarks
A GridEngine overrides this method and returns a reference to the GridGroupingControl since all events need to be marshaled to the same thread that the GridGroupingControl is running on.
OnBindingContextChanged(EventArgs)
Triggered when the BindingContextChanged event is done.
Declaration
protected virtual void OnBindingContextChanged(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.EventArgs | e | An System.EventArgs contains the event data. |
OnCategorizedRecords(TableEventArgs)
Overrides and raises when the CategorizedRecords event is done.
Declaration
protected override void OnCategorizedRecords(TableEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
TableEventArgs | e | AnTableEventArgs contains the event data. |
Overrides
OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs)
Overrides and triggered when the CurrentRecordContextChange event is done.
Declaration
protected override void OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
CurrentRecordContextChangeEventArgs | e | AnCurrentRecordContextChangeEventArgs contains the event data. |
Overrides
OnSourceListChanged(TableEventArgs)
Triggered when the SourceListChanged event is done.
Declaration
protected override void OnSourceListChanged(TableEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
TableEventArgs | e | An TableEventArgs contains the event data. |
Overrides
OnSourceListListChanged(TableListChangedEventArgs)
Overrides and raises the SourceListListChanged event.
Declaration
protected override void OnSourceListListChanged(TableListChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
TableListChangedEventArgs | e | A System.ComponentModel.ListChangedEventArgs contains the event data. |
Overrides
ResetCurrencyManager()
Resets the CurrencyManager to NULL and unwires any events.
Declaration
public void ResetCurrencyManager()
Events
BindingContextChanged
Occurs when the BindingContext gets changed.
Declaration
public event EventHandler BindingContextChanged
Event Type
Type |
---|
System.EventHandler |