WinForms

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

    Show / Hide Table of Contents

    Class DataTableCollectionViewWrapper

    Represents the class that used to create the collection view for data table and data view.

    Inheritance
    System.Object
    CollectionViewAdv
    DataTableCollectionView
    DataTableCollectionViewWrapper
    Implements
    ICollectionViewAdv
    System.Collections.IEnumerable
    System.ComponentModel.INotifyPropertyChanged
    ISupportInitialize
    System.IDisposable
    IPropertyChangedEventHandler
    IEditableCollectionView
    IUnboundExpressionFunc
    IGridViewNotifier
    Inherited Members
    DataTableCollectionView.GetSource()
    DataTableCollectionView.SetSource(IEnumerable)
    DataTableCollectionView.OnSortDescriptionChanged(NotifyCollectionChangedEventArgs)
    DataTableCollectionView.FilterRecord(Object)
    DataTableCollectionView.RefreshSort()
    DataTableCollectionView.GetGroupResult(String[])
    DataTableCollectionView.ResetFilter()
    DataTableCollectionView.RefreshSortingOrderWithFiltersForBottomLevel(List<Group>, String, Int32)
    DataTableCollectionView.UpdateCollectionView(Object, NotifyCollectionChangedEventArgs)
    DataTableCollectionView.CommitEdit()
    DataTableCollectionView.AddNew()
    DataTableCollectionView.CancelNew()
    DataTableCollectionView.CommitNew()
    DataTableCollectionView.ViewSource
    DataTableCollectionView.RowFilter
    CollectionViewAdv.currentItem
    CollectionViewAdv.currentPosition
    CollectionViewAdv.IsInSuspend
    CollectionViewAdv.IsInEndDeferral
    CollectionViewAdv.IsInPropertyChange
    CollectionViewAdv.IsInGroup
    CollectionViewAdv.propertyAccessProvider
    CollectionViewAdv.ItemPropertiesSet
    CollectionViewAdv.IsItemPropertiesTypeSet
    CollectionViewAdv.IsInCommitNew
    CollectionViewAdv.IsInSourceCollectionChange
    CollectionViewAdv.IsDisposed
    CollectionViewAdv.editItem
    CollectionViewAdv.IsInCommitEdit
    CollectionViewAdv.CreateRecordEntry(Object)
    CollectionViewAdv.SetSourceType(Type)
    CollectionViewAdv.GetItemProperties()
    CollectionViewAdv.GetPropertyAccessProvider()
    CollectionViewAdv.SetItemProperties(IEnumerable)
    CollectionViewAdv.GetSourceListCollection()
    CollectionViewAdv.DeferRefresh()
    CollectionViewAdv.DeferRefresh(Boolean)
    CollectionViewAdv.Refresh()
    CollectionViewAdv.Contains(Object)
    CollectionViewAdv.OnCollectionChanged(NotifyCollectionChangedEventArgs)
    CollectionViewAdv.RefreshView(NotifyCollectionChangedEventArgs)
    CollectionViewAdv.RaiseExceptionThrownEvent(Exception)
    CollectionViewAdv.RaiseCollectionChangedEvent(NotifyCollectionChangedEventArgs)
    CollectionViewAdv.RaiseSourceCollectionChangedEvent(NotifyCollectionChangedEventArgs)
    CollectionViewAdv.MoveCurrentTo(Object)
    CollectionViewAdv.MoveCurrentToFirst()
    CollectionViewAdv.MoveCurrentToLast()
    CollectionViewAdv.MoveCurrentToNext()
    CollectionViewAdv.MoveCurrentToPosition(Int32)
    CollectionViewAdv.SetCurrent(Object, Int32)
    CollectionViewAdv.SetCurrent(Object, Int32, Int32)
    CollectionViewAdv.RaiseCurrentChangedEvent()
    CollectionViewAdv.MoveCurrentToPrevious()
    CollectionViewAdv.IndexOf(Object)
    CollectionViewAdv.Insert(Int32, Object)
    CollectionViewAdv.RemoveAt(Int32)
    CollectionViewAdv.GetItemAt(Int32)
    CollectionViewAdv.Add(Object)
    CollectionViewAdv.Clear()
    CollectionViewAdv.CopyTo(Object[], Int32)
    CollectionViewAdv.Remove(Object)
    CollectionViewAdv.GetEnumerator()
    CollectionViewAdv.IEnumerable.GetEnumerator()
    CollectionViewAdv.BeginInit(Boolean)
    CollectionViewAdv.EndInit()
    CollectionViewAdv.EnsureView()
    CollectionViewAdv.EnsureInitialized()
    CollectionViewAdv.AddNotifyListener(Object)
    CollectionViewAdv.RemoveNotifyListener(Object)
    CollectionViewAdv.InitiateCollectionViewAdv()
    CollectionViewAdv.EnsureSourceList()
    CollectionViewAdv.SetFlag(CollectionViewAdv.CollectionViewFlags, Boolean)
    CollectionViewAdv.UnWireEvents()
    CollectionViewAdv.SourceListChanged(Object, ListChangedEventArgs)
    CollectionViewAdv.OnRecordCollectionChanged(Object, NotifyCollectionChangedEventArgs)
    CollectionViewAdv.OnTopLevelGroupPopulated(TopLevelGroup)
    CollectionViewAdv.RefreshTopLevelGroup()
    CollectionViewAdv.RaiseGroupCollectionChanged(NotifyGroupsChangedEventArgs)
    CollectionViewAdv.OnTopLevelGroupCollectionChanged(Object, NotifyCollectionChangedEventArgs)
    CollectionViewAdv.OnPropertyChanged(Object, PropertyChangedEventArgs)
    CollectionViewAdv.NotifyPropertyChangedHandler(Object, PropertyChangedEventArgs)
    CollectionViewAdv.OnRecordPropertyChanged(Object, PropertyChangedEventArgs)
    CollectionViewAdv.RemoveRecord(Object)
    CollectionViewAdv.SetActiveComparer()
    CollectionViewAdv.GetActiveComparer()
    CollectionViewAdv.GetComparerIndex(Object, Int32)
    CollectionViewAdv.AdjustBeforeAdd(Object, Int32)
    CollectionViewAdv.GetExpressionFunc(String, DataOperation, DataReflectionMode)
    CollectionViewAdv.RaisePropertyChanged(String)
    CollectionViewAdv.Dispose()
    CollectionViewAdv.CancelEdit()
    CollectionViewAdv.GetRecordAt(Int32)
    CollectionViewAdv.EndEdit()
    CollectionViewAdv.EditItem(Object)
    CollectionViewAdv.FetchSize
    CollectionViewAdv.IsDynamicBound
    CollectionViewAdv.Records
    CollectionViewAdv.EnableSummaryOptimization
    CollectionViewAdv.IsInDeferRefresh
    CollectionViewAdv.IsGrouping
    CollectionViewAdv.GroupList
    CollectionViewAdv.TopLevelGroup
    CollectionViewAdv.CaptionSummaryRow
    CollectionViewAdv.SummaryRows
    CollectionViewAdv.TableSummaryRows
    CollectionViewAdv.SortComparers
    CollectionViewAdv.SourceType
    CollectionViewAdv.IsLegacyDataTable
    CollectionViewAdv.ItemProperties
    CollectionViewAdv.Culture
    CollectionViewAdv.Filter
    CollectionViewAdv.FilterPredicates
    CollectionViewAdv.GroupDescriptions
    CollectionViewAdv.SortDescriptions
    CollectionViewAdv.SourceCollection
    CollectionViewAdv.LiveDataUpdateMode
    CollectionViewAdv.SummaryCalculationMode
    CollectionViewAdv.SummaryCalculationUnit
    CollectionViewAdv.Groups
    CollectionViewAdv.IsEmpty
    CollectionViewAdv.IsCurrentAfterLast
    CollectionViewAdv.IsCurrentBeforeFirst
    CollectionViewAdv.CurrentItem
    CollectionViewAdv.CurrentPosition
    CollectionViewAdv.Item[Int32]
    CollectionViewAdv.Count
    CollectionViewAdv.IsReadOnly
    CollectionViewAdv.CanFilter
    CollectionViewAdv.CanGroup
    CollectionViewAdv.CanSort
    CollectionViewAdv.NotificationSubscriptionMode
    CollectionViewAdv.AutoExpandGroups
    CollectionViewAdv.CanCancelEdit
    CollectionViewAdv.CurrentEditItem
    CollectionViewAdv.IsEditingItem
    CollectionViewAdv.CanAddNew
    CollectionViewAdv.CanRemove
    CollectionViewAdv.CurrentAddItem
    CollectionViewAdv.IsAddingNew
    CollectionViewAdv.NewItemPlaceholderPosition
    CollectionViewAdv.RecordPropertyChanged
    CollectionViewAdv.CollectionChanged
    CollectionViewAdv.SourceCollectionChanged
    CollectionViewAdv.TopLevelGroupCollectionChanged
    CollectionViewAdv.CurrentChanged
    CollectionViewAdv.PropertyChanged
    System.Object.ToString()
    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.WinForms.DataGrid.Data
    Assembly: Syncfusion.SfDataGrid.WinForms.dll
    Syntax
    public class DataTableCollectionViewWrapper : DataTableCollectionView, ICollectionViewAdv, IEnumerable, INotifyPropertyChanged, ISupportInitialize, IDisposable, IPropertyChangedEventHandler, IEditableCollectionView, IUnboundExpressionFunc, IGridViewNotifier

    Constructors

    DataTableCollectionViewWrapper(IEnumerable, SfDataGrid)

    Initializes a new instance of the DataTableCollectionViewWrapper class. class.

    Declaration
    public DataTableCollectionViewWrapper(IEnumerable source, SfDataGrid dataGrid)
    Parameters
    Type Name Description
    System.Collections.IEnumerable source

    The source that need to be added as the DataTable or DataView.

    SfDataGrid dataGrid

    The grid that need to be assigned with the given source.

    Methods

    AttachGridView(Object)

    Initializes the grid.

    Declaration
    public override void AttachGridView(object dataGrid)
    Parameters
    Type Name Description
    System.Object dataGrid

    The data Grid.

    Overrides
    CollectionViewAdv.AttachGridView(Object)

    CanUpdateSummary(ISummaryRow, String)

    The can update summary.

    Declaration
    protected override bool CanUpdateSummary(ISummaryRow row, string propertyName)
    Parameters
    Type Name Description
    ISummaryRow row

    The row.

    System.String propertyName

    The property name.

    Returns
    Type Description
    System.Boolean

    The System.Boolean.

    Overrides
    CollectionViewAdv.CanUpdateSummary(ISummaryRow, String)

    CreateItemPropertiesProvider()

    Creates the property provider for the grid item.

    Declaration
    protected override ItemPropertiesProvider CreateItemPropertiesProvider()
    Returns
    Type Description
    ItemPropertiesProvider

    Returns the ItemPropertiesProvider for the grid columns.

    Overrides
    CollectionViewAdv.CreateItemPropertiesProvider()

    CreateRecords()

    Creates the records to the grid based on the ItemsSource.

    Declaration
    protected override RecordsList CreateRecords()
    Returns
    Type Description
    RecordsList

    Returns the RecordList collection.

    Overrides
    DataTableCollectionView.CreateRecords()

    CreateTopLevelGroup()

    Creates a top-level group for the datagrid.

    Declaration
    protected override TopLevelGroup CreateTopLevelGroup()
    Returns
    Type Description
    TopLevelGroup

    Returns the top-level group.

    Overrides
    CollectionViewAdv.CreateTopLevelGroup()

    DetachGridView()

    Clears the grid while Disposing the DataTableCollectionViewWrapper.

    Declaration
    public override void DetachGridView()
    Overrides
    CollectionViewAdv.DetachGridView()

    Dispose(Boolean)

    Disposes all the resources used by the DataTableCollectionViewWrapper class.

    Declaration
    protected override void Dispose(bool isDisposing)
    Parameters
    Type Name Description
    System.Boolean isDisposing

    Indicates the call is from Dispose method.

    Overrides
    CollectionViewAdv.Dispose(Boolean)

    GetDataGrid()

    Gets the grid that attached to the collection view wrapper.

    Declaration
    public override object GetDataGrid()
    Returns
    Type Description
    System.Object

    Returns the data grid.

    Overrides
    CollectionViewAdv.GetDataGrid()

    GetFunc(String, DataOperation, DataReflectionMode)

    Gets the func for corresponding data operation and property name.

    Declaration
    public override Func<string, object, object> GetFunc(string propertyName, DataOperation operation = DataOperation.Default, DataReflectionMode reflectionMode = DataReflectionMode.Value)
    Parameters
    Type Name Description
    System.String propertyName

    The mapping name of the column.

    DataOperation operation

    The data operation that is being performed.

    DataReflectionMode reflectionMode

    The reflection mode for the operation.

    Returns
    Type Description
    System.Func<System.String, System.Object, System.Object>

    Returns the Func for the given data operation.

    Overrides
    CollectionViewAdv.GetFunc(String, DataOperation, DataReflectionMode)

    GetSelectedRecords()

    Gets the selected records from SfDataGrid to calculate the selected records summaries.

    Declaration
    public override ObservableCollection<object> GetSelectedRecords()
    Returns
    Type Description
    System.Collections.ObjectModel.ObservableCollection<System.Object>

    Returns the selected items collection

    Overrides
    CollectionViewAdv.GetSelectedRecords()

    RefreshFilter(Boolean)

    Clear Selection if the selected item is not in View

    Declaration
    public override void RefreshFilter(bool isProgrammatic)
    Parameters
    Type Name Description
    System.Boolean isProgrammatic

    if View need to clear the selection in SFDataGrid, using View.RowFilter expression; set true. The default value is false.

    Overrides
    DataTableCollectionView.RefreshFilter(Boolean)

    Implements

    ICollectionViewAdv
    System.Collections.IEnumerable
    System.ComponentModel.INotifyPropertyChanged
    ISupportInitialize
    System.IDisposable
    IPropertyChangedEventHandler
    IEditableCollectionView
    IUnboundExpressionFunc
    IGridViewNotifier

    Extension Methods

    DataTableCollectionViewExt.GetFilterString(CollectionViewAdv)
    DataTableCollectionViewExt.GetFilterString(CollectionViewAdv, String, Boolean)
    DataTableCollectionViewExt.GetClonedSource(CollectionViewAdv)
    QueryableCollectionViewExtensions.GetPredicateExpressionExt(CollectionViewAdv, IQueryable, out ParameterExpression)
    QueryableCollectionViewExtensions.GetPredicateExpressionExt(CollectionViewAdv, IQueryable, out ParameterExpression, String, Boolean)
    CollectionViewExtensions.GetValueFunc(CollectionViewAdv, GridColumn, DataOperation, DataReflectionMode)
    CollectionViewExtensions.GetValueExpressionFunc(CollectionViewAdv, GridColumn, DataOperation, DataReflectionMode)
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved