CompositeObjectSpace.IsKnownType(Type, Boolean) Method

Checks whether the Object Space (or any Object Space from its AdditionalObjectSpaces collection) can handle objects of the specified type.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v23.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public bool IsKnownType(
    Type objectType,
    bool checkAdditionalObjectSpaces
)

VB.NET

Public Function IsKnownType(
    objectType As Type,
    checkAdditionalObjectSpaces As Boolean
) As Boolean

Parameters

Name	Type	Description
objectType	Type	The type this method checks.
checkAdditionalObjectSpaces	Boolean	Indicates if the method should also check Object Spaces from the AdditionalObjectSpaces collection.

Returns

Type	Description
Boolean	true if the Object Space (or any Object Space from its AdditionalObjectSpaces collection) can handle objects of the specified type.

Remarks

The following example demonstrates how to use this property in a platform-agnostic module (MySolution.Module\Module.cs(vb)):

C#

using DevExpress.ExpressApp;
//...
public class MySolutionModule : ModuleBase {
    //...
    public override void Setup(XafApplication application) {
        base.Setup(application);
        application.ObjectSpaceCreated += Application_ObjectSpaceCreated;
    }
    private void Application_ObjectSpaceCreated(object s, ObjectSpaceCreatedEventArgs e) {
        var nonPersistentObjectSpace = e.ObjectSpace as NonPersistentObjectSpace;
        if (nonPersistentObjectSpace != null) {
            if (!nonPersistentObjectSpace.IsKnownType(typeof(Person), true)) {
                // ...
            }
        }
    }
}

VB.NET

Imports DevExpress.ExpressApp
'...
Public 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 s As Object, ByVal e As ObjectSpaceCreatedEventArgs)
        Dim nonPersistentObjectSpace As NonPersistentObjectSpace = TryCast(e.ObjectSpace, NonPersistentObjectSpace)
        If nonPersistentObjectSpace IsNot Nothing Then
            If Not nonPersistentObjectSpace.IsKnownType(GetType(Person), True) Then
                ' ...
            End If
        End If
    End Sub
End Class

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the IsKnownType(Type, Boolean) 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-custom-logon-parameters/CS/XPO/WebForms/CustomLogonXPOWeb/CustomLogonXPOWeb.Web/Global.asax.cs#L58

if (nonPersistentObjectSpace != null) {
    if (!nonPersistentObjectSpace.IsKnownType(typeof(Company), true)) {
        IObjectSpace additionalObjectSpace = ((XafApplication)sender).CreateObjectSpace(typeof(Company));