DataSourceCriteriaPropertyAttribute Class

Applied to business classes‘ reference and collection properties. Specifies the name of a CriteriaOperator type property which returns data source’s filter criteria applied to the List View displayed in a Lookup Property Editor or invoked by the LinkUnlinkController.LinkAction Action in a popup window.

Namespace: DevExpress.Persistent.Base

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

[AttributeUsage(AttributeTargets.Property, Inherited = true, AllowMultiple = false)]
public sealed class DataSourceCriteriaPropertyAttribute :
    ModelExportedValueAttribute

VB.NET

<AttributeUsage(AttributeTargets.Property, Inherited:=True, AllowMultiple:=False)>
Public NotInheritable Class DataSourceCriteriaPropertyAttribute
    Inherits ModelExportedValueAttribute

Remarks

You can filter the data source for the List View displayed in a Lookup Property Editor or in the LinkUnlinkController.LinkAction Action’s popup window. For this purpose, apply the DataSourceCriteriaProperty attribute to the target property. The constructor of this attribute accepts a string name of the CriteriaOperator type property whose value can be calculated in code as required (see DataSourceCriteriaPropertyAttribute.DataSourceCriteriaProperty).

The following example demonstrates how to use the DataSourceCriteriaProperty attribute:

C# (EF Core)

using DevExpress.Data.Filtering;
using DevExpress.Persistent.Base;
using DevExpress.Persistent.BaseImpl.EF;
using System.ComponentModel.DataAnnotations;
// ...
[DefaultClassOptions]
public class Order : BaseObject {
    [DataSourceCriteriaProperty(nameof(DepartmentsCriteria))]
    public virtual Accessory Accessory { get; set; }
    public CriteriaOperator DepartmentsCriteria {
        get { return CriteriaOperator.Parse("IsGlobal = true"); }
    }
}

public class Accessory : BaseObject {
    public virtual bool IsGlobal { get; set; }
}

// Make sure that you use options.UseChangeTrackingProxies() in your DbContext settings.

C# (XPO)

using DevExpress.Data.Filtering;
using DevExpress.Persistent.Base;
using DevExpress.Persistent.BaseImpl;
// ...
[DefaultClassOptions]
public class Order : BaseObject {
    private Accessory fAccessory;
    [DataSourceCriteriaProperty(nameof(DepartmentsCriteria))]
    public Accessory Accessory {
        get { return fAccessory; }
        set {
            SetPropertyValue(nameof(Accessory), ref fAccessory, value);
        }
    }
    public CriteriaOperator DepartmentsCriteria {
        get { return CriteriaOperator.Parse("IsGlobal = true"); }
    }
}
public class Accessory : BaseObject {
    // ...
    private bool fIsGlobal;
    public bool IsGlobal {
        get { return fIsGlobal; }
        set {
            SetPropertyValue(nameof(IsGlobal), ref fIsGlobal, value);
        }
    }
}

VB.NET (XPO)

Imports DevExpress.Data.Filtering
Imports DevExpress.Persistent.Base
Imports DevExpress.Persistent.BaseImpl
' ...
<DefaultClassOptions>
Public Class Order
    Inherits BaseObject
    Private fAccessory As Accessory
    <DataSourceCriteriaProperty(NameOf(DepartmentsCriteria))>
    Public Property Accessory As Accessory
        Get
            Return fAccessory
        End Get
        Set(ByVal value As Accessory)
            SetPropertyValue(NameOf(Accessory), fAccessory, value)
        End Set
    End Property
    Public ReadOnly Property DepartmentsCriteria As CriteriaOperator
        Get
            Return CriteriaOperator.Parse("IsGlobal = true")
        End Get
    End Property
End Class

Public Class Accessory
    Inherits BaseObject
    Private fIsGlobal As Boolean
    Public Property IsGlobal As Boolean
        Get
            Return fIsGlobal
        End Get
        Set(ByVal value As Boolean)
            SetPropertyValue(NameOf(IsGlobal), fIsGlobal, value)
        End Set
    End Property
End Class

DataSourceCriteriaPropertyAttribute overrides DataSourceCriteriaAttribute when both attributes are applied to the same property.

Alternatively, you can use the IModelMember.DataSourceCriteriaProperty and IModelMemberViewItem.DataSourceCriteriaProperty settings that are available in the Application Model for the class members, ListView columns and DetailView items.

Inheritance

Object

Attribute

DevExpress.Persistent.Base.ModelExportedValueAttribute

DataSourceCriteriaPropertyAttribute