XPClassInfo.CreateMember(String, Type, Boolean, Attribute[]) Method

Creates a new member metadata.

Namespace: DevExpress.Xpo.Metadata

Assembly: DevExpress.Xpo.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap, DevExpress.Xpo

NuGet Package: DevExpress.Xpo

Declaration

C#

public XPCustomMemberInfo CreateMember(
    string propertyName,
    Type propertyType,
    bool nonPersistent,
    params Attribute[] attributes
)

VB.NET

Public Function CreateMember(
    propertyName As String,
    propertyType As Type,
    nonPersistent As Boolean,
    ParamArray attributes As Attribute()
) As XPCustomMemberInfo

Parameters

Name	Type	Description
propertyName	String	A String value which specifies the name of the new member.
propertyType	Type	A Type descendant which represents the type of the new member. The created member type will be nullable, i.e if you pass bool, the type will be Nullable<bool>.
nonPersistent	Boolean	true if the new member is not persistent; otherwise, false.
attributes	Attribute[]	An array of Attribute objects that represent the attributes of the new member.

Returns

Type	Description
XPCustomMemberInfo	An XPCustomMemberInfo descendant which provides the new member’s metadata.

Remarks

The CreateMember method allows custom members to be created dynamically.

Example

The following sample code shows how to create custom fields using the XPClassInfo.CreateMember method.

C#

using DevExpress.Xpo;
using DevExpress.Xpo.Metadata;
// ...

XPClassInfo customerClassInfo = Session.DefaultSession.GetClassInfo(typeof(Customer));
customerClassInfo.CreateMember("Name", typeof(string));
customerClassInfo.CreateMember("CompanyName", typeof(string));
// Set the nonPersistent parameter to true for collection properties
customerClassInfo.CreateMember("Orders", typeof(XPCollection), true, 
    new AssociationAttribute("CustomerOrders", typeof(Order)), new AggregatedAttribute());

VB.NET

Imports DevExpress.Xpo
Imports DevExpress.Xpo.Metadata
' ...

Dim customerClassInfo As XPClassInfo = Session.DefaultSession.GetClassInfo(GetType(Customer))
customerClassInfo.CreateMember("Name", GetType(String))
customerClassInfo.CreateMember("CompanyName", GetType(String))
' Set the nonPersistent parameter to True for collection properties
customerClassInfo.CreateMember("Orders", GetType(XPCollection), True, _
    New AssociationAttribute("CustomerOrders", GetType(Order)), New AggregatedAttribute())

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CreateMember(String, Type, Boolean, Attribute[]) 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#

XPO_how-to-persist-metadata-e269/CS/MetadataObjects.cs#L120

protected override XPMemberInfo CreateMemberCore(XPClassInfo owner) {
    return owner.CreateMember(Name, typeof(XPCollection), true);
}

XPO_how-to-generate-persistent-classes-at-runtime-based-on-a-dataset-e1198/CS/WindowsApplication4/Form1.cs#L54

order.CreateMember("CustomerId", customer, new Attribute[] { a1 });
customer.CreateMember("Orders", typeof(XPCollection), true, new Attribute[] { a });
gridControl1.DataSource = new XPCollection(Session.DefaultSession, customer);

VB.NET

XPO_how-to-persist-metadata-e269/VB/MetadataObjects.vb#L170

Protected Overrides Function CreateMemberCore(ByVal owner As XPClassInfo) As XPMemberInfo
    Return owner.CreateMember(Name, GetType(XPCollection), True)
End Function

XPO_how-to-generate-persistent-classes-at-runtime-based-on-a-dataset-e1198/VB/WindowsApplication4/Form1.vb#L52

order.CreateMember("CustomerId", customer, New Attribute() {a1})
customer.CreateMember("Orders", GetType(XPCollection), True, New Attribute() { a })
gridControl1.DataSource = New XPCollection(Session.DefaultSession, customer)