XPO and XAF Templates

• Jun 26, 2019
• 2 minutes to read

This topic describes templates you can use when you implement business classes in eXpressApp Framework (XAF) and eXpress Persistent Objects (XPO).

Member declaration

XPO persistent class

Template: xc

C#

public class PersistentClass : XPObject {
    public PersistentClass(Session session) : base(session) { }
}

VB.NET

Public Class PersistentClass
    Inherits XPObject
    Public Sub New(ByVal session As Session)
        MyBase.New(session)
    End Sub
End Class

XPO persistent property

Template: xp*

* This template must be followed by a type mnemonic. For details, refer to the Members Declaration article. xps (string) template.

C#

string propertyName;
[Size(SizeAttribute.DefaultStringMappingFieldSize)]
public string PropertyName {
    get => propertyName;
    set => SetPropertyValue(nameof(PropertyName), ref propertyName, value);
}

VB.NET

Private _propertyName As String
<Size(SizeAttribute.DefaultStringMappingFieldSize)>
Property PropertyName As String
    Get
        Return _propertyName
    End Get
    Set(ByVal Value As String)
        SetPropertyValue(Nameof(PropertyName), _propertyName, Value)
    End Set
End Property

XPO-associated property

Template: xpa

C#

object propertyName;
[Association("object-Programs")]
public object PropertyName {
    get => propertyName;
    set => SetPropertyValue(nameof(PropertyName), ref propertyName, value);
}

VB.NET

Private _propertyName As Object
<Association("Object-Persons")> _
Property PropertyName() As Object
    Get
        Return _propertyName
    End Get
    Set(ByVal Value As Object)
        SetPropertyValue(Nameof(PropertyName), _propertyName, Value)
    End Set
End Property

XPO-associated collection

Template: xpcl

C#

[Association("Program-Relations")]
public XPCollection<RelationType> Relations {
    get {
        return GetCollection<RelationType>(nameof(Relations));
    }
}

VB.NET

<Association("Person-Relations")> 
Public ReadOnly Property Relations() As XPCollection(Of RelationType)
    Get
        Return GetCollection(Of RelationType)(NameOf(Relations))
    End Get
End Property

XPO read-only persistent property

Template: xr*

* This template must be followed by a type mnemonic. For details, refer to the Members Declaration article. xri (Integer) template.

C#

[Persistent(nameof(PropertyName))]
int propertyName;
[PersistentAlias(nameof(propertyName))]
public int PropertyName {
    get { return propertyName; }
}

VB.NET

<Persistent(Nameof(PropertyName))> _
Private _propertyName As Integer

<PersistentAlias(Nameof(_propertyName))> _
ReadOnly Property PropertyName As Integer
    Get
        Return _propertyName
    End Get
End Property

XPO Types

CodeRush includes XPO type mnemonics you can use in member declaration templates.

Type	Mnemonic
DevExpress.Data.Filtering.AggregateOperand	xao
DevExpress.Data.Filtering.BetweenOperator	xbwo
DevExpress.Data.Filtering.BinaryOperator	xbo
DevExpress.Data.Filtering.FunctionOperator	xfo
DevExpress.Data.Filtering.GroupOperator	xgo
DevExpress.Data.Filtering.InOperator	xio
DevExpress.Data.Filtering.UnaryOperator	xuo
DevExpress.Xpo.Session	xss
DevExpress.Xpo.UnitOfWork	xu
DevExpress.Xpo.XPCollection	xcl

For instance, you can use the p template with the xss mnemonic (the pxss template) to declare a DevExpress.Xpo.Session type property.

C#

DevExpress.Xpo.Session propertyName;

public DevExpress.Xpo.Session PropertyName {
    get { return propertyName; }
    set {
        propertyName = value;
    }
}

VB.NET

Private _propertyName As DevExpress.Xpo.Session

Public Property PropertyName As DevExpress.Xpo.Session
    Get
        Return _propertyName
    End Get
    Set(ByVal value As DevExpress.Xpo.Session)
        _propertyName = value
    End Set
End Property