IObjectSpace.GetObjects<T>(CriteriaOperator) Method

Returns an IList collection of objects of the specified type, retrieved to the current Object Space and filtered according to the specified criteria.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v23.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

IList<T> GetObjects<T>(
    CriteriaOperator criteria
)

VB.NET

Function GetObjects(Of T)(
    criteria As CriteriaOperator
) As IList(Of T)

Parameters

Name	Type	Description
criteria	CriteriaOperator	A CriteriaOperator which specifies the criteria for object selection.

Type Parameters

Name	Description
T	The Type of objects that are retrieved.

Returns

Type	Description
IList<T>	A IList collection that contains the persistent objects of the specified type. Only objects that satisfy the specified criteria will be retrieved to this collection.

Remarks

The following example uses a Parametrized Action to search for a Person by LastName, and then assigns all deferred tasks to that person.

C#

using System.Collections.Generic;
using DevExpress.Data.Filtering;
using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Actions;
using DevExpress.Persistent.Base;
using DevExpress.Persistent.Base.General;
using DevExpress.Persistent.BaseImpl;
// ...
public class AssignTasksController : ObjectViewController<ListView, MainDemo.Module.BusinessObjects.DemoTask> {
    public AssignTasksController() {
        ParametrizedAction assignTasksAction = new ParametrizedAction(
            this, "AssignTasks", PredefinedCategory.Edit, typeof(string));
        assignTasksAction.Execute += AssignTasksAction_Execute;
    }
    private void AssignTasksAction_Execute(object sender, ParametrizedActionExecuteEventArgs e) {
        IObjectSpace objectSpace = View.ObjectSpace;
        string personParamValue = e.ParameterCurrentValue as string;
        CriteriaOperator personCriteria = CriteriaOperator.Parse("Contains([LastName], ?)", personParamValue);
        Person person = (Person)objectSpace.FindObject(typeof(Person), personCriteria);
        if(person != null) {
            CriteriaOperator taskCriteria = CriteriaOperator.Parse("[Status] = ?", TaskStatus.Deferred);
            IList<MainDemo.Module.BusinessObjects.DemoTask> tasks =
                objectSpace.GetObjects<MainDemo.Module.BusinessObjects.DemoTask>(taskCriteria);
            foreach(MainDemo.Module.BusinessObjects.DemoTask task in tasks) {
                task.AssignedTo = person;
            }
        }
    }
}

VB.NET

Imports System.Collections.Generic
Imports DevExpress.Data.Filtering
Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.Actions
Imports DevExpress.Persistent.Base
Imports DevExpress.Persistent.Base.General
Imports DevExpress.Persistent.BaseImpl

Public Class AssignTasksController
    Inherits ObjectViewController(Of ListView, MainDemo.Module.BusinessObjects.DemoTask)
    Public Sub New()
        Dim assignTasksAction As New ParametrizedAction(Me, "AssignTasks", PredefinedCategory.Edit, GetType(String))
        AddHandler assignTasksAction.Execute, AddressOf AssignTasksAction_Execute
    End Sub
    Private Sub AssignTasksAction_Execute(ByVal sender As Object, ByVal e As ParametrizedActionExecuteEventArgs)
        Dim objectSpace As IObjectSpace = View.ObjectSpace
        Dim personParamValue As String = TryCast(e.ParameterCurrentValue, String)
        Dim personCriteria As CriteriaOperator = CriteriaOperator.Parse("Contains([LastName], ?)", personParamValue)
        Dim person As Person = CType(objectSpace.FindObject(GetType(Person), personCriteria), Person)
        If person IsNot Nothing Then
            Dim taskCriteria As CriteriaOperator = CriteriaOperator.Parse("[Status] = ?", TaskStatus.Deferred)
            Dim tasks As IList(Of MainDemo.Module.BusinessObjects.DemoTask) = _
                objectSpace.GetObjects(Of MainDemo.Module.BusinessObjects.DemoTask)(taskCriteria)
            For Each task As MainDemo.Module.BusinessObjects.DemoTask In tasks
                task.AssignedTo = person
            Next task
        End If
    End Sub
End Class

When implementing the IObjectSpace interface in the BaseObjectSpace class’s descendant, don’t implement the GetObjects<T> method. It’s implemented in the BaseObjectSpace class. To get the specified objects, the BaseObjectSpace.GetObjects<T>(CriteriaOperator criteria) method invokes a generic protected virtual CreateCollection method that does nothing and returns null. So, you should override the generic CreateCollection method in your descendant.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetObjects<T>(CriteriaOperator) method.

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-save-and-share-custom-view-settings/CS/ViewSettingsSolution.Module/Controllers/ViewVariantsController.cs#L60

IObjectSpace objectSpace = Application.CreateObjectSpace(typeof(SettingsStore));
foreach(SettingsStore item in objectSpace.GetObjects<SettingsStore>(criteria)) {
    SelectViewVariantAction.Items.Add(new ChoiceActionItem(item.Name, item));

XAF_Non-Persistent-Objects-Filtering-Demo/CS/NonPersistentObjectsDemo.Module/Controllers/FindArticlesController.cs#L63

_Articles.Clear();
foreach(var obj in ObjectSpace.GetObjects<Article>(filter)) {
    _Articles.Add(obj);

VB.NET

xaf-save-and-share-custom-view-settings/VB/ViewSettingsSolution.Module/Controllers/ViewVariantsController.vb#L76

Dim objectSpace As IObjectSpace = Application.CreateObjectSpace(GetType(SettingsStore))
For Each item As SettingsStore In objectSpace.GetObjects(Of SettingsStore)(criteria)
    SelectViewVariantAction.Items.Add(New ChoiceActionItem(item.Name, item))

XAF_Non-Persistent-Objects-Filtering-Demo/VB/NonPersistentObjectsDemo.Module/Controllers/FindArticlesController.vb#L75

_Articles.Clear()
For Each obj In ObjectSpace.GetObjects(Of Article)(filter)
    _Articles.Add(obj)