Interface ICollectionViewAdv
Enables collections to have the functionalities of current record management, custom sorting, filtering, and grouping.
Inherited Members
Namespace: Syncfusion.Data
Assembly: Syncfusion.Data.Portable.dll
Syntax
public interface ICollectionViewAdv : ICollectionView, IEnumerable, INotifyCollectionChanged, INotifyPropertyChanged, ISupportInitialize, IDisposable, IPropertyChangedEventHandler, IEditableCollectionView, ISupportIncrementalLoading
Properties
AutoExpandGroups
Gets or sets a value that indicates whether the group caption is expanded automatically during grouping.
Declaration
bool AutoExpandGroups { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | True if the group caption is expanded automatically, otherwise false. |
CanFilter
Gets sets a boolean value indicating whether filtering can be performed.
Declaration
bool CanFilter { get; }
Property Value
Type | Description |
---|---|
System.Boolean | A boolean value indicating whether to filtering can be performed. |
CaptionSummaryRow
Gets or sets the ISummaryRow which maintains the group caption summary information of the collection view.
Declaration
ISummaryRow CaptionSummaryRow { get; set; }
Property Value
Type | Description |
---|---|
ISummaryRow | The ISummaryRow which maintains the group caption summary information of the collection view. |
Culture
Gets or sets the System.Globalization.CultureInfo of the collection view.
Declaration
CultureInfo Culture { get; set; }
Property Value
Type | Description |
---|---|
System.Globalization.CultureInfo | The System.Globalization.CultureInfo of the collection view. |
Filter
Gets or sets the predicate to apply custom filter on source.
Declaration
Predicate<object> Filter { get; set; }
Property Value
Type | Description |
---|---|
System.Predicate<System.Object> | The predicate to apply custom filter on source. |
FilterPredicates
Gets or sets the collection of IFilterDefinition to maintain the filtering information.
Declaration
ObservableCollection<IFilterDefinition> FilterPredicates { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.ObjectModel.ObservableCollection<IFilterDefinition> | The collection of IFilterDefinition to maintain the filtering information. |
GroupComparer
Gets or sets the group comparer, which contains the logic to be applied for grouping the data based on the custom logic.
Declaration
IComparer<Group> GroupComparer { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IComparer<Group> | The group comparer, which contains the logic to be applied for grouping the data based on the custom logic. |
GroupDescriptions
Gets the collection of group descriptions, that contains the columns that represent grouping in the collection view.
Declaration
ObservableCollection<GroupDescription> GroupDescriptions { get; }
Property Value
Type | Description |
---|---|
System.Collections.ObjectModel.ObservableCollection<GroupDescription> | The collection of group descriptions, that contains the columns that represent grouping in the collection view. |
IsDynamicBound
Gets or sets the value that indicates whether the data object is System.Dynamic.
Declaration
bool IsDynamicBound { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | True if the data object is dynamic, otherwise false. |
IsInDeferRefresh
Gets a value that indicates whether the DeferRefresh(Boolean) in action.
Declaration
bool IsInDeferRefresh { get; }
Property Value
Type | Description |
---|---|
System.Boolean | True if the DeferRefresh(Boolean) in action, otherwise false. |
IsLegacyDataTable
Gets a value that indicates whether the underlying data object is System.Data.DataTable.
Declaration
bool IsLegacyDataTable { get; }
Property Value
Type | Description |
---|---|
System.Boolean | True if the underlying data object is DataTable, otherwise false. |
IsXElementBound
Gets the value that indicates whether the data object is System.Xml.Linq.XElement.
Declaration
bool IsXElementBound { get; }
Property Value
Type | Description |
---|---|
System.Boolean | True if the data object is XElement, otherwise false. |
LiveDataUpdateMode
Gets or sets the LiveDataUpdateMode to control data manipulation operations during data updates.
Declaration
LiveDataUpdateMode LiveDataUpdateMode { get; set; }
Property Value
Type | Description |
---|---|
LiveDataUpdateMode | One of the LiveDataUpdateMode that indicates how data manipulation operations are handled during data updates. The default value is Default. |
Records
Gets the records collection of the collection view, which includes the records displayed in the view.
Declaration
RecordsList Records { get; }
Property Value
Type | Description |
---|---|
RecordsList | The IRecordsList of records which includes the records displayed in the view. |
Remarks
When the
SortComparers
Gets the SortComparers to sort the data using custom logic.
Declaration
SortComparers SortComparers { get; }
Property Value
Type | Description |
---|---|
SortComparers | The SortComparers which contains the custom logic for sorting. |
SortDescriptions
Gets the collection of sort descriptions, that contains the columns that represent sorting in the collection view.
Declaration
SortDescriptionCollection SortDescriptions { get; }
Property Value
Type | Description |
---|---|
SortDescriptionCollection | The collection of sort descriptions, that contains the columns that represent sorting in the collection view. |
SourceCollection
Gets the IEnumerable source collection of the collection view.
Declaration
IEnumerable SourceCollection { get; }
Property Value
Type | Description |
---|---|
System.Collections.IEnumerable | The IEnumerable source collection of the collection view. |
SummaryCalculationMode
Gets or sets a value that denotes the mode of calculation for caption and group summaries for improved performance.
Declaration
CalculationMode SummaryCalculationMode { get; set; }
Property Value
Type | Description |
---|---|
CalculationMode | One of the CalculationMode that indicates when to perform the summary calculation. The default value is Default. |
SummaryRows
Gets the collection of ISummaryRow which maintains the summary rows information of the collection view.
Declaration
ObservableCollection<ISummaryRow> SummaryRows { get; }
Property Value
Type | Description |
---|---|
System.Collections.ObjectModel.ObservableCollection<ISummaryRow> | The collection of ISummaryRow which maintains the summary rows information of the collection view. |
TableSummaryRows
Gets the collection of ISummaryRow which maintains the table summary rows information.
Declaration
ObservableCollection<ISummaryRow> TableSummaryRows { get; }
Property Value
Type | Description |
---|---|
System.Collections.ObjectModel.ObservableCollection<ISummaryRow> | The collection of ISummaryRow which maintains table summary rows information. |
TopLevelGroup
Gets the TopLevelGroup of the collection view, which maintains the group information
when the
Declaration
TopLevelGroup TopLevelGroup { get; }
Property Value
Type | Description |
---|---|
TopLevelGroup | The TopLevelGroup which maintains the group information of the collection view, which maintains the group information
when the |
Methods
CreateRecordEntry(Object)
Creates the RecordEntry for associated data object.
Declaration
RecordEntry CreateRecordEntry(object data)
Parameters
Type | Name | Description |
---|---|---|
System.Object | data | The data object to create RecordEntry. |
Returns
Type | Description |
---|---|
RecordEntry | The RecordEntry for the specified data object. |
DeferRefresh()
Get a disposable DeferHelper to suspends the all data operations in View.
Declaration
IDisposable DeferRefresh()
Returns
Type | Description |
---|---|
System.IDisposable | Returns disposable DeferHelper to do the bulk changes |
FilterRecord(Object)
Filters the record in the collection for the specified record condition.
Declaration
bool FilterRecord(object record)
Parameters
Type | Name | Description |
---|---|---|
System.Object | record | The record to be filtered in the collection. |
Returns
Type | Description |
---|---|
System.Boolean | True if the filter condition is satisfied, otherwise false. |
GetItemProperties()
Gets the collection of item properties, that contains the property and its information.
Declaration
PropertyDescriptorCollection GetItemProperties()
Returns
Type | Description |
---|---|
System.ComponentModel.PropertyDescriptorCollection | The collection of item properties, that contains the property and its information. |
GetPropertyAccessProvider()
Gets the ItemPropertiesProvider which handles the reflection for CollectionViewAdv.
Declaration
ItemPropertiesProvider GetPropertyAccessProvider()
Returns
Type | Description |
---|---|
ItemPropertiesProvider | Returns the ItemPropertiesProvider which handles the reflection for CollectionViewAdv. |
GetRecordAt(Int32)
Gets the RecordEntry at the specified index.
Declaration
RecordEntry GetRecordAt(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The index to get the record. |
Returns
Type | Description |
---|---|
RecordEntry | Returns the RecordEntry for the specified index. |
OnCollectionChanged(NotifyCollectionChangedEventArgs)
Method that handles the CollectionChanged event with the provided arguments.
Declaration
void OnCollectionChanged(NotifyCollectionChangedEventArgs args)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Specialized.NotifyCollectionChangedEventArgs | args | A System.Collections.Specialized.NotifyCollectionChangedEventArgs that contains the event data. |
Refresh()
Refreshes the view.
Declaration
void Refresh()
RefreshFilter(Boolean)
Refreshes the view when the filtering is applied through FilterRecord(Object) delegate.
Declaration
void RefreshFilter(bool isProgrammatic = false)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | isProgrammatic | A boolean value indicating whether filtering is done programmatically. |
Events
RecordPropertyChanged
Occurs when the property is changed for the data objects on the collection.
Declaration
event PropertyChangedEventHandler RecordPropertyChanged
Event Type
Type |
---|
System.ComponentModel.PropertyChangedEventHandler |
Remarks
The data object should implement the System.ComponentModel.INotifyPropertyChanged interface.
SourceCollectionChanged
Occurs when the underlying source collection is changed.
Declaration
event NotifyCollectionChangedEventHandler SourceCollectionChanged
Event Type
Type |
---|
System.Collections.Specialized.NotifyCollectionChangedEventHandler |
Remarks
The data object should implement the System.Collections.Specialized.INotifyCollectionChanged interface.