Back to Devexpress

ListView.CollectionSource Property

expressappframework-devexpress-dot-expressapp-dot-listview-e74461e7.md

latest6.0 KB
Original Source

ListView.CollectionSource Property

Provides access to a ListView‘s Collection Source.

Namespace : DevExpress.ExpressApp

Assembly : DevExpress.ExpressApp.v25.2.dll

NuGet Package : DevExpress.ExpressApp

Declaration

csharp
public CollectionSourceBase CollectionSource { get; }
vb
Public ReadOnly Property CollectionSource As CollectionSourceBase

Property Value

TypeDescription
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.

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.

XAF_how-to-show-filter-dialog-before-listview/CS/EFCore/DialogBeforeListViewEF/DialogBeforeListViewEF.Module/Controllers/NewViewFilterObjectController.cs#L11

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

xaf-how-to-import-data-in-xaf/CS/XPO/ImportData/ImportData.Module/Controllers/ImportDataListViewController.cs#L40

csharp
ListView lv = (ListView)View;
PropertyCollectionSource pcs = lv.CollectionSource as PropertyCollectionSource;
if (pcs != null) {

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

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

xaf-how-to-use-criteria-property-editors/CS/EFCore/CriteriaPropertiesEF/CriteriaPropertiesEF.Module/Controllers/CriteriaController.cs#L25

csharp
private void FilteringCriterionAction_Execute(object sender, SingleChoiceActionExecuteEventArgs e) {
    var collectionSource = View.CollectionSource;
    collectionSource.BeginUpdateCriteria();

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

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

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

vb
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

See Also

ObjectSpace

ListView Class

ListView Members

DevExpress.ExpressApp Namespace