ListView.CollectionSource Property

Provides access to a ListView‘s Collection Source.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v24.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public CollectionSourceBase CollectionSource { get; }

VB.NET

Public ReadOnly Property CollectionSource As CollectionSourceBase

Property Value

Type	Description
CollectionSourceBase	A CollectionSourceBase object representing the current List View’s collection source.

Remarks

A Collection Source is used to retrieve a collection of objects of the specified type, from an object space that will be used by a List View. The CollectionSource property allows you to use the members of the current List View’s Collection Source.

To learn about Collection Sources, refer to the CollectionSourceBase class description.

An example is available in the Criteria Property of a List View's Collection Source article.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CollectionSource property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XAF_how-to-show-filter-dialog-before-listview/CS/E1554.Module/NewViewFilterObjectController.cs#L12

base.OnActivated();
if (View.CollectionSource is PropertyCollectionSource && ((PropertyCollectionSource)View.CollectionSource).MasterObjectType == typeof(ViewFilterContainer)) {
    NewObjectViewController newObjectViewController = Frame.GetController<NewObjectViewController>();

xaf-separate-employees-data-in-different-departments-using-security-permissions/CS/MainDemo.Module/Controllers/HideProtectedContentController.cs#L26

((ColumnWrapper)e.Item).PropertyName, null,
((ListView)View).CollectionSource, View.ObjectSpace)) {
e.AppearanceObject.Visibility = ViewItemVisibility.Hide;

XAF_Non-Persistent-Objects-Edit-Linked-Persistent-Objects-Demo/CS/NonPersistentObjectsDemo.Module/Controllers/ProductViewNestedCollectionController.cs#L17

base.OnActivated();
var pcs = View.CollectionSource as PropertyCollectionSource;
var linkUnlinkController = Frame.GetController<LinkUnlinkController>();

VB.NET

XAF_how-to-show-filter-dialog-before-listview/VB/E1554.Module/NewViewFilterObjectController.vb#L14

MyBase.OnActivated()
If TypeOf View.CollectionSource Is PropertyCollectionSource AndAlso CType(View.CollectionSource, PropertyCollectionSource).MasterObjectType Is GetType(ViewFilterContainer) Then
    Dim newObjectViewController As NewObjectViewController = Frame.GetController(Of NewObjectViewController)()

xaf-separate-employees-data-in-different-departments-using-security-permissions/VB/MainDemo.Module/Controllers/HideProtectedContentController.vb#L33

If Not DataManipulationRight.CanRead(View.ObjectTypeInfo.Type, (CType(e.Item, ColumnWrapper)).PropertyName, Nothing, (CType(View, ListView)).CollectionSource, View.ObjectSpace) Then
    e.AppearanceObject.Visibility = ViewItemVisibility.Hide

XAF_Non-Persistent-Objects-Edit-Linked-Persistent-Objects-Demo/VB/NonPersistentObjectsDemo.Module/Controllers/ProductViewNestedCollectionController.vb#L19

MyBase.OnActivated()
Dim pcs = TryCast(View.CollectionSource, PropertyCollectionSource)
Dim linkUnlinkController = Frame.GetController(Of LinkUnlinkController)()