WinForms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridTableBase

    Show / Hide Table of Contents

    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.

    Inheritance
    System.Object
    Element
    Table
    GridTableBase
    GridTable
    Implements
    ITreeTableCounterSource
    ITreeTableSummaryArraySource
    System.IDisposable
    Inherited Members
    Table.WireTableDescriptor()
    Table.UnwireTableDescriptor()
    Table.GetVisibleCount()
    Table.GetYAmountCount()
    Table.GetElementCount()
    Table.GetSummaries()
    Table.GetSummaries(Table, Boolean)
    Table.GetEmptySummaries()
    Table.GetFilteredRecordCount()
    Table.GetRecordCount()
    Table.InvalidateCounterTopDown(Boolean)
    Table.InvalidateSummariesTopDown()
    Table.InvalidateSummary()
    Table.InvalidateSummariesBottomUp()
    Table.OnEnsureInitialized(Object)
    Table.ToString()
    Table.ClearCollectionCaches()
    Table.Reload()
    Table.OnExceptionRaised(ExceptionRaisedEventArgs)
    Table.OnInvalidatingCounters(TableEventArgs)
    Table.OnInvalidatingSummaries(TableEventArgs)
    Table.OnSourceListRecordChanged(RecordChangedEventArgs)
    Table.OnSourceListRecordChanging(RecordChangedEventArgs)
    Table.OnSourceListListChangedCompleted(TableListChangedEventArgs)
    Table.OnGroupSummaryInvalidated(GroupEventArgs)
    Table.OnGroupAdded(GroupEventArgs)
    Table.OnGroupRemoving(GroupEventArgs)
    Table.OnGroupCollapsing(GroupEventArgs)
    Table.OnGroupCollapsed(GroupEventArgs)
    Table.OnGroupExpanding(GroupEventArgs)
    Table.OnGroupExpanded(GroupEventArgs)
    Table.OnRecordCollapsing(RecordEventArgs)
    Table.OnRecordCollapsed(RecordEventArgs)
    Table.OnRecordExpanding(RecordEventArgs)
    Table.OnRecordExpanded(RecordEventArgs)
    Table.OnRecordDeleting(RecordEventArgs)
    Table.OnRecordDeleted(RecordEventArgs)
    Table.OnSortingItemsInGroup(GroupEventArgs)
    Table.OnSortedItemsInGroup(GroupEventArgs)
    Table.OnCurrentRecordManagerReset(TableEventArgs)
    Table.AddNew()
    Table.BeginEdit()
    Table.EndEdit()
    Table.CancelEdit()
    Table.IsSameRecord(Record, Int32)
    Table.GetRecordOrParentRecord(Element)
    Table.IsSameGroup(Group, Element)
    Table.ResetCurrentRecord()
    Table.GetInnerMostCurrentElement()
    Table.IsCurrentRecord(Int32)
    Table.NavigateCurrentRecordUp(Int32)
    Table.NavigateCurrentRecordDown(Int32)
    Table.ExpandAllGroups()
    Table.ExpandAllRecords()
    Table.CollapseAllGroups()
    Table.CollapseAllRecords()
    Table.ShowRecord(Element, Boolean)
    Table.ShowRecord(Record, Boolean)
    Table.OnSelectedRecordsChanging(SelectedRecordsChangedEventArgs)
    Table.OnSelectedRecordsChanged(SelectedRecordsChangedEventArgs)
    Table.OnDefaultYAmountChanged(EventArgs)
    Table.RaiseDefaultYAmountChanged()
    Table.ShouldCacheRecordData()
    Table.OnRecordValueChanging(RecordValueChangingEventArgs)
    Table.RaiseRecordValueChanging(RecordValueChangingEventArgs)
    Table.OnRecordValueChanged(RecordValueChangedEventArgs)
    Table.RaiseRecordValueChanged(RecordValueChangedEventArgs)
    Table.UnwireList()
    Table.WireList()
    Table.SimulateListChangedWithSourceList(IList, Group, ListChangedEventArgs)
    Table.SimulateListChanged(ListChangedEventArgs)
    Table.AddChildTableIfNotExists(Object[])
    Table.AddChildTable()
    Table.DeleteRecord(Record)
    Table.PopulateRecordChildTablesIfEmpty(Record)
    Table.OnPopulatedChildTable(ChildTable)
    Table.PopulatePassThroughGroupIfEmpty(Group)
    Table.PopulatePassThroughGroup(Group, IEnumerable, Record)
    Table.OnRemovingRelatedTable(TableEventArgs)
    Table.OnAddedRelatedTable(TableEventArgs)
    Table.OnDisplayElementChanging(DisplayElementChangingEventArgs)
    Table.OnDisplayElementChanged(DisplayElementChangedEventArgs)
    Table.RaiseDisplayElementChanging(Element, Int32, Int32, Boolean, Boolean, Boolean, Boolean)
    Table.RaiseDisplayElementChanged(Element, Int32, Int32, Boolean, Boolean, Boolean, Boolean)
    Table.RaiseDisplayElementChanging(Element, Int32, Int32, Boolean, Boolean, Boolean)
    Table.RaiseDisplayElementChanged(Element, Int32, Int32, Boolean, Boolean, Boolean)
    Table.OnQueryCustomCount(CustomCountEventArgs)
    Table.OnQueryVisibleCustomCount(CustomCountEventArgs)
    Table.OnRelatedTableSourceListListChanged(TableListChangedEventArgs)
    Table.OnRelatedTableSourceListListChangedCompleted(TableListChangedEventArgs)
    Table.OnPrepareRemoving(Object)
    Table.OnPrepareItemAdded(Object)
    Table.GetValue(Object, PropertyDescriptor)
    Table.AddChangedField(ChangedFieldInfo)
    Table.GetChangedFields()
    Table.EnsureInitialized(Object, Boolean)
    Table.OnSourceListPropertyDescriptorChanged(Object, ListChangedEventArgs, TableListChangedEventArgs)
    Table.OnSourceListReset(Object, ListChangedEventArgs, TableListChangedEventArgs)
    Table.OnSourceListItemAdded(Object, ListChangedEventArgs, TableListChangedEventArgs)
    Table.OnSourceListItemMoved(Object, ListChangedEventArgs, TableListChangedEventArgs)
    Table.OnSourceListItemDeleted(Object, ListChangedEventArgs, TableListChangedEventArgs)
    Table.OnSourceListItemChanged(Object, ListChangedEventArgs, TableListChangedEventArgs)
    Table.OnRecordChanged(Element, Boolean, Boolean)
    Table.CompareColumnSortOrder(Record, Record, Record, SortColumnDescriptor)
    Table.DeleteEmptyGroups(DetailsSection, Group)
    Table.CompareGroupCategories(Group, Record)
    Table.InvalidateCountersAndSummaries(Element, Boolean)
    Table.InvalidateCounters(Element)
    Table.InvalidateSummaries(Element, Boolean)
    Table.OnCategorizingRecords(TableEventArgs)
    Table.GetDependantFields(Int32)
    Table.Engine
    Table.TableNo
    Table.TableEventsTarget
    Table.ParentTableDescriptor
    Table.OriginalSourceList
    Table.RelationParentTable
    Table.TableDescriptor
    Table.EngineVersion
    Table.CurrentRecordManager
    Table.AddNewRecord
    Table.HasCurrentRecord
    Table.CurrentRecord
    Table.CurrentElement
    Table.HasCurrentElement
    Table.NestedDisplayElements
    Table.DisplayElements
    Table.NestedElements
    Table.Elements
    Table.FilteredRecords
    Table.Records
    Table.SelectedRecords
    Table.UnsortedRecords
    Table.PrimaryKeySortedRecords
    Table.TopLevelGroup
    Table.DefaultSummaryRowHeight
    Table.DefaultRecordRowHeight
    Table.DefaultRecordPreviewRowHeight
    Table.DefaultCaptionRowHeight
    Table.DefaultColumnHeaderRowHeight
    Table.DefaultEmptySectionHeight
    Table.DefaultGroupHeaderSectionHeight
    Table.DefaultGroupFooterSectionHeight
    Table.DefaultGroupPreviewSectionHeight
    Table.DefaultFilterBarRowHeight
    Table.DefaultIndentWidth
    Table.DefaultRowHeaderWidth
    Table.DefaultTableIndentWidth
    Table.TableDirty
    Table.CountersDirty
    Table.SummariesDirty
    Table.SourceListVersion
    Table.SourceListAllowNew
    Table.SourceListAllowRemove
    Table.SourceListAllowEdit
    Table.HasSourceList
    Table.SourceList
    Table.InSetSourceList
    Table.InSourceListChanged
    Table.LastChangedRecord
    Table.InSourceListListChangedHandler
    Table.InInitialize
    Table.CategorizeElementsVersion
    Table.PassThroughGroupingResult
    Table.IsPassThroughGrouping
    Table.TableDirtyOnItemChanged
    Table.RecordsAsDisplayElements
    Table.WithoutCounter
    Table.VirtualMode
    Table.IsSorting
    Table.FilteredChildTableOrTopLevelGroup
    Table.FilteredChildTable
    Table.AllowThreading
    Table.RelatedTables
    Table.HasColumnChangeListener
    Table.ChangedFieldsArray
    Table.StartIndex
    Table.EndIndex
    Table.ExceptionRaised
    Table.GroupExpanding
    Table.GroupExpanded
    Table.GroupCollapsing
    Table.GroupCollapsed
    Table.RecordExpanding
    Table.RecordExpanded
    Table.RecordDeleting
    Table.RecordDeleted
    Table.RecordCollapsing
    Table.RecordCollapsed
    Table.CategorizingRecords
    Table.CategorizedRecords
    Table.SortingItemsInGroup
    Table.SortedItemsInGroup
    Table.GroupSummaryInvalidated
    Table.GroupAdded
    Table.GroupRemoving
    Table.SourceListRecordChanging
    Table.SourceListRecordChanged
    Table.SourceListListChanged
    Table.SourceListListChangedCompleted
    Table.InvalidatingCounters
    Table.InvalidatingSummaries
    Table.CurrentRecordContextChange
    Table.CurrentRecordManagerReset
    Table.SelectedRecordsChanging
    Table.SelectedRecordsChanged
    Table.DefaultYAmountChanged
    Table.SettingTableDirty
    Table.SourceListChanged
    Table.RecordValueChanging
    Table.RecordValueChanged
    Table.RemovingRelatedTable
    Table.AddedRelatedTable
    Table.DisplayElementChanging
    Table.DisplayElementChanged
    Table.QueryCustomCount
    Table.QueryVisibleCustomCount
    Element.SupportsId()
    Element.Dispose()
    Element.OnDisposed(EventArgs)
    Element.EnsureInitialized(Object)
    Element.GetCounter()
    Element.InvalidateCounterBottomUp()
    Element.InvalidateCounter()
    Element.OnElementTreeInvalidateCounterBottomUp()
    Element.GetSummaries(Table)
    Element.GetCustomCount()
    Element.GetVisibleCustomCount()
    Element.IsChildVisible(Element)
    Element.GetVisibleInParent()
    Element.GetVisibleInHierarchy()
    Element.GetChildCount()
    Element.GetCustomPosition()
    Element.GetVisibleCustomPosition()
    Element.ITreeTableSummaryArraySource.GetSummaries(ITreeTableEmptySummaryArraySource, Boolean)
    Element.GetData()
    Element.OnBeginEditCalled()
    Element.OnBeginEditComplete(Boolean)
    Element.OnEndEditCalled()
    Element.OnEndEditComplete(Boolean)
    Element.OnCancelEditCalled()
    Element.OnCancelEditComplete(Boolean)
    Element.OnLeaveRecordCalled()
    Element.OnLeaveRecordComplete(Boolean)
    Element.OnEnterRecordCalled()
    Element.OnEnterRecordComplete(Boolean)
    Element.IsCaption(Element)
    Element.IsRecord(Element)
    Element.IsColumnHeader(Element)
    Element.IsFilterBar(Element)
    Element.IsCaption()
    Element.IsRecord()
    Element.IsColumnHeader()
    Element.IsFilterBar()
    Element.GetCaptionSection(Element)
    Element.GetRecord(Element)
    Element.GetColumnHeaderSection(Element)
    Element.GetFilterBar(Element)
    Element.GetCaptionSection()
    Element.GetRecord()
    Element.GetColumnHeaderSection()
    Element.GetFilterBar()
    Element.EngineTable
    Element.ParentTable
    Element.TableLevel
    Element.Id
    Element.Reserved1
    Element.Reserved2
    Element.Reserved3
    Element.Reserved4
    Element.Reserved5
    Element.Reserved6
    Element.Reserved7
    Element.Reserved8
    Element.Reserved9
    Element.Reserved10
    Element.Reserved11
    Element.Reserved16a
    Element.Reserved16b
    Element.Reserved16c
    Element.Info
    Element.Kind
    Element.Disposing
    Element.IsDisposed
    Element.InDisposed
    Element.ParentElement
    Element.ParentDisplayElement
    Element.ParentGroup
    Element.ParentRecord
    Element.ParentChildTable
    Element.ParentSection
    Element.GroupLevel
    Element.ChildTableGroupLevel
    Element.Disposed
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    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 Description
    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
    Table.bindingList_ListChanged(Object, ListChangedEventArgs)

    Dispose(Boolean)

    Overrides and manages the resources.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing
    Overrides
    Table.Dispose(Boolean)

    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
    Table.dt_RowDeleting(Object, DataRowChangeEventArgs)

    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
    Table.OnCategorizedRecords(TableEventArgs)

    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
    Table.OnCurrentRecordContextChange(CurrentRecordContextChangeEventArgs)

    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
    Table.OnSourceListChanged(TableEventArgs)

    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
    Table.OnSourceListListChanged(TableListChangedEventArgs)

    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 Description
    System.EventHandler

    Implements

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