NonPersistentObjectSpace.CustomGetObjectsQuery Event

Occurs when the GetObjectsQuery<T>(Boolean) method is executed.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v20.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public event EventHandler<CustomGetObjectsQueryEventArgs> CustomGetObjectsQuery

VB.NET

Public Event CustomGetObjectsQuery As EventHandler(Of CustomGetObjectsQueryEventArgs)

Event Data

The CustomGetObjectsQuery event's data class is DevExpress.ExpressApp.CustomGetObjectsQueryEventArgs.

Remarks

Handle this event to pass a custom strongly-typed query of non-persistent objects to the GetObjectsQuery<T>(Boolean) method. The following example shows how to handle this event in the platform-agnostic Module (the MySolution.Module project):

C#

using DevExpress.ExpressApp;
using System.Collections.Generic;
using System.Linq;
// ...
public sealed partial class MySolutionModule : ModuleBase {
    // ...
    public override void Setup(XafApplication application) {
        base.Setup(application);
        application.ObjectSpaceCreated += Application_ObjectSpaceCreated;
    }
    private void Application_ObjectSpaceCreated(object sender, ObjectSpaceCreatedEventArgs e) {
        NonPersistentObjectSpace nonPersistentObjectSpace = e.ObjectSpace as NonPersistentObjectSpace;
        if (nonPersistentObjectSpace != null) {
            nonPersistentObjectSpace.CustomGetObjectsQuery += NonPersistentObjectSpace_CustomGetObjectsQuery;
            //...
        }
    }
    List<Article> articles;
    // ...
    private void NonPersistentObjectSpace_CustomGetObjectsQuery(object sender, CustomGetObjectsQueryEventArgs e) {
        if (typeof(Article).IsAssignableFrom(e.ObjectType)) {
            e.Queryable = articles.AsQueryable();
        }
    }
}

VB.NET

Imports DevExpress.ExpressApp
Imports System.Collections.Generic
Imports System.Linq
' ...
Public NotInheritable Partial Class MySolutionModule
    Inherits ModuleBase
    ' ...
    Public Overrides Sub Setup(ByVal application As XafApplication)
        MyBase.Setup(application)
        AddHandler application.ObjectSpaceCreated, AddressOf Application_ObjectSpaceCreated
    End Sub
    Private Sub Application_ObjectSpaceCreated(ByVal sender As Object, ByVal e As ObjectSpaceCreatedEventArgs)
        Dim nonPersistentObjectSpace As NonPersistentObjectSpace = TryCast(e.ObjectSpace, NonPersistentObjectSpace)
        If nonPersistentObjectSpace IsNot Nothing Then
            AddHandler nonPersistentObjectSpace.CustomGetObjectsQuery, AddressOf NonPersistentObjectSpace_CustomGetObjectsQuery
            '...
        End If
    End Sub
    Private articles As List(Of Article)
    ' ...
    Private Sub NonPersistentObjectSpace_CustomGetObjectsQuery(ByVal sender As Object, ByVal e As CustomGetObjectsQueryEventArgs)
        If GetType(Article).IsAssignableFrom(e.ObjectType) Then
            e.Queryable = articles.AsQueryable()
        End If
    End Sub
End Class