PersistentAliasAttribute & CalculatedAttribute & CalculatedPersistentAliasAttribute

Posted 2020-09-20 foreach

一,PersistentAliasAttribute-[XPO提供]

Indicates that a property is not persistent and its value is calculated based upon the values of a specific field(s).

 指示某个属性不是持久性的, 并且它的值是根据特定字段的值计算的。

 

The expression to be evaluated can be passed as the constructor‘s parameter or specified via the AliasExpression property. You can use both persistent and non-persistent fields to specify the expressions. The expression is evaluated at the server side when only persistent properties are used. When a non-persistent property is referred, XPO extracts a persistent part from an expression, sends it to the database server, and processes the rest on the client. Note that this is only possible when an operation involves object loading and won‘t work in XPView.

 要计算的表达式可以作为构造函数的参数传递或通过 AliasExpression 属性指定。您可以使用持久性字段和非持久域来指定表达式。当只使用持久性属性时, 在服务器端计算表达式。当引用非持久性属性时, xpo 从表达式中提取持久性部分, 将其发送到数据库服务器, 并在客户端上处理其余内容。请注意, 只有当操作涉及对象加载并且无法在 XPView 中工作时, 才可能出现这种情况。

 Example

 

The following code shows how to define a property as non-persistent and calculate its value based upon the values of specific persistent fields. The ‘ExtendedPrice‘ property is marked as a non-persistent, using thePersistentAliasAttribute attribute. The expression to evaluate the property‘s value is specified as the attribute‘s parameter. In addition, the property‘s getter evaluates this expression using the XPBaseObject.EvaluateAliasmethod.

 

 

下面的代码演示如何将属性定义为非持久性, 并根据特定持久性字段的值计算其值。使用 PersistentAliasAttribute 属性将ExtendedPrice

属性标记为非持久性。

 

用于计算属性值的表达式被指定为属性的参数。此外, 该属性的 getter 使用 XPBaseObject EvaluateAliasmethod 计算此表达式。

 

 

using DevExpress.Xpo;

public class Order : XPObject {
   public Order() {}
   public decimal UnitPrice;
   public int Qty;
   public decimal Discount;

   [PersistentAlias("UnitPrice*Qty*(1-Discount)")]
   public decimal ExtendedPrice {
      get { return Convert.ToDecimal(EvaluateAlias("ExtendedPrice")); }
   }
}

 

 

Note that while a criteria expression can return an object reference, this is not supported in all scenarios. Returning an object reference by directly referencing a property, as in the following code snippet, is fully supported.

请注意, 虽然条件表达式可以返回对象引用, 但在所有方案中不支持此项。完全支持通过直接引用属性 (如下面的代码段) 返回对象引用。

[PersistentAlias("Iif(Part is null, MyCustOrderLine.Part, Part)")]
public Part CustomPart {
    get {
        return (Part)EvaluateAlias("CustomPart");
    }
}

 

In this code snippet, a Part object referenced by the Part or MyCustOrderLine.Part property will be returned correctly. However, retrieving reference properties from function and aggregation operators is not supported. So, the following persistent alias declaration will not work.

在此代码段中, Part对象引用Part或MyCustOrderLine.Part属性,部件属性将正确返回。

但是, 不支持从函数和聚合运算符检索引用属性。因此, 下列持久性别名声明将不起作用。

[PersistentAlias("Iif(Part is null, MyCustOrderLine, MyCustOrderLine2).Part")]
public Part CustomPart {
    get {
        return (Part)EvaluateAlias("CustomPart");
    }
}

 

 

 Example

 

The following example shows how to apply the PersistentAliasAttribute to the DefaultAddress property. When initializing a new instance of the PersistentAliasAttribute class, the name of the field which stores theDefaultAddress property‘s value is specified. The mDefaultAddress field has the PersistentAttribute whose PersistentAttribute.MapTo property holds the name of the column in the data store where the field‘s value is stored.

下面的示例演示如何将 PersistentAliasAttribute 应用于 DefaultAddress 属性。在初始化 PersistentAliasAttribute 类的新实例时, 将指定存储 theDefaultAddress 属性值的字段的名称。mDefaultAddress 字段具有 PersistentAttribute, 其 PersistentAttribute. MapTo 是字段名。

 

using DevExpress.Xpo;

// ...
[Persistent("DefaultAddress")]
private string mDefaultAddress;

[PersistentAlias("mDefaultAddress")]
public string DefaultAddress {
    get {
        return mDefaultAddress;
    }
}

 

 

二,CalculatedAttribute - [XAF提供]

 Applied to business class properties. Specifies an expression used to calculate the target property value in the Data View mode.

 应用于业务类属性。指定用于在数据DataView 模式下计算目标属性值的表达式。

Below is an example of using the CalculatedAttribute.

using DevExpress.ExpressApp.DC;
// ... 
public class Person {    
    // ... 
    public String FirstName { get; set; }
    public String LastName { get; set; }
    [Calculated("FirstName + ‘ ‘ + LastName")]
    public String FullName {
        get {
            return FirstName + " " + LastName;
        }
    }
}

 

Properties, used in the Expression should be persistent to be able to run an SQL query at the database level.

在表达式中使用的属性应该是持久的, 以便能够在数据库级别运行 sql 查询。

 

三,CalculatedPersistentAliasAttribute - [XAF提供]

Applied to a business class. Allows you to dynamically configure a persistent alias for the target business class‘ property.

 

动态的指定计算字段的公式.

Non-persistent calculated properties for which filtering and sorting should be performed on the database level can be implemented via the PersistentAlias attribute. The PersistentAlias attribute takes a single parameter which specifies the expression used to calculate the property‘s value on the database server side. A persistent alias must be specified in code as the attribute‘s parameter. However, in certain scenarios, the property may be required to have a configurable persistent alias, and it must be possible to configure it in a deployed application by an administrator. In this instance, the CalculatedPersistentAliasAttribute attribute should be used.

可通过 PersistentAlias 属性实现在数据库级别上执行筛选和排序的非持化的计算属性。

PersistentAlias 属性采用一个参数来指定用于计算数据库服务器端属性值的表达式。

必须在代码中将持久性别名指定为属性的参数。

但是, 在某些情况下, 该属性可能需要具有可配置的持久别名, 并且必须可以在部署的应用程序中由管理员对其进行配置。

在此实例中, 应使用 CalculatedPersistentAliasAttribute 属性。

 

The CalculatedPersistentAliasAttribute contains two properties initialized via the attribute‘s constructor. The first parameter specifies the property name for which you would like to set up a persistent alias. The second parameter specifies the property which returns the alias‘ expression. The property which returns the alias‘ expression can return different expressions based on a specific rule. For example, you can implement logic which loads the alias expression from a configuration file which can be customized by a system administrator.

Note that the CalculatedPersistentAliasAttribute attribute is initialized at the application startup, while the application is being set up. So, if you want to change the value returned by the property which specifies the alias expression, this should be done while the application is being initialized, for example, in a module‘s constructor.

The following code snippet illustrates use of the CalculatedPersistentAliasAttribute. The Product class contains the calculated ProductName property, which has a configurable persistent alias:

 

CalculatedPersistentAliasAttribute 构造函数中有两个参数。

第一个参数指定要为其设置永久别名的属性名。

第二个参数指定返回别名 "表达式" 的属性。

返回别名 "表达式" 的属性可以根据特定规则返回不同的表达式。例如, 您可以实现从配置文件中加载别名表达式的逻辑, 系统管理员可以自定义它。

 

请注意, 在应用程序初始化时, CalculatedPersistentAliasAttribute 属性在应用程序启动时初始化。因此, 如果要更改指定别名表达式的属性返回的值, 则应在初始化应用程序时 (例如在模块的构造函数中) 执行此操作。

 

下面的代码段说明了 CalculatedPersistentAliasAttribute 的使用。该产品类包含计算的产品属性, 它具有可配置的持久别名:

Show Me

The complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=E1771.

 

[CalculatedPersistentAlias("ProductName", "ProductNameAlias"), DefaultClassOptions]
//ProductName 这个属性的值将来从ProductNameAlias中取得公式内容.
public class Product : BaseObject {
    public Product(Session session) : base(session) { }

    private static string productNameFormat = "{Manufacturer} {Model}";
    private static string productNameAlias = "concat(Manufacturer, Model)";
        
    public string ProductName {
        get { return ObjectFormatter.Format(
            productNameFormat, this, EmptyEntriesMode.RemoveDelimiterWhenEntryIsEmpty ); }
    }
    [Browsable(false)]
    public static string ProductNameAlias {
        get { return productNameAlias; }            
    }
    public static void SetProductNameFormat(string productNameFormat, string productNameAlias) {
        if(!string.IsNullOrEmpty(productNameFormat)) {
            Product.productNameFormat = productNameFormat;
        }
        if(!string.IsNullOrEmpty(productNameAlias)) {
            Product.productNameAlias = productNameAlias;
        }
    }

    public string Manufacturer {
        get { return GetPropertyValue<string>("Manufacturer"); }
        set { SetPropertyValue<string>("Manufacturer", value); }
    }
    public string Model {
        get { return GetPropertyValue<string>("Model"); }
        set { SetPropertyValue<string>("Model", value); }
    }
    public string Revision {
        get { return GetPropertyValue<string>("Revision"); }
        set { SetPropertyValue<string>("Revision", value); }
    }
}

 

The persistent alias‘ value is initialized from the application‘s configuration file in a module‘s constructor:

Note that a property which returns the persistent alias‘ expression must be declared as public and static (Public and Shared in VB).

在模块的构造函数中, 从应用程序的配置文件中初始化持久性别名 "值:

请注意, 返回持久性别名" 表达式的属性必须声明为公共和静态 (在 vb 中为公共和共享)。

public sealed partial class CalculatedAliasModule : ModuleBase {
    public CalculatedAliasModule() {
        InitializeComponent();
         
        Product.SetProductNameFormat(    
            ConfigurationManager.AppSettings["ProductNameFormat"],    
            ConfigurationManager.AppSettings["ProductNameAlias"]    
            );   
    }
}

 

此外, 还需要以下列方式重写 ModuleBase. CustomizeTypesInfo 方法:

 

using DevExpress.ExpressApp.Xpo;
// ... 
public override void CustomizeTypesInfo(ITypesInfo typesInfo) {
    base.CustomizeTypesInfo(typesInfo);
    CalculatedPersistentAliasHelper.CustomizeTypesInfo(typesInfo);
}

 

Note that two business classes from the Business Class Library use the CalculatedPersistentAliasAttribute attribute. The Person class uses this attribute to configure the format of the calculated FullName property, and theAddress class uses this attribute to configure the calculated FullAddress property. To learn how to configure the format of these properties, refer to the How to: Change the Format Used for the FullAddress and FullName Properties topic.

 

 请注意, 业务类库中的两个业务类使用 CalculatedPersistentAliasAttribute 属性。"人员" 类使用此特性来配置计算的 fullname 属性的格式, 而地址类使用此特性来配置计算的 FullAddress 属性。

要了解如何配置这些属性的格式,请参阅如何: 更改用于 FullAddress 和 fullname 属性主题的格式。