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

Creates a new member metadata.

Namespace: DevExpress.Xpo.Metadata

Assembly: DevExpress.Xpo.v23.2.dll

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

NuGet Package: DevExpress.Xpo

Declaration

C#

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

VB.NET

Public Function CreateMember(
    propertyName As String,
    propertyType As Type,
    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>.
attributes	Attribute[]	An array of Attribute objects that represent 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, 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#

asp-net-mvc-grid-custom-binding-and-xpo/CS/XPCustomBindingExample/XPO/DatabaseSchemaHelper.cs#L11

XPClassInfo ordersTable = dictionary.CreateClass("Order");
ordersTable.CreateMember("ID", typeof(int), new KeyAttribute(true));
ordersTable.CreateMember("ProductName", typeof(string));

XPO_how-to-define-a-persistent-class-at-runtime-e1139/CS/CreateClassAtRuntime/Program.cs#L18

XPClassInfo myClassA = dictionary.CreateClass(myBaseClass, "MyObjectA");
myClassA.CreateMember("ID", typeof(int), new KeyAttribute(true));
myClassA.CreateMember("Name", typeof(string));

XPO_how-to-generate-persistent-metadata-for-an-arbitrary-data-table-e2922/CS/MapArbitraryDatabaseExample/Program.cs#L40

DBColumnType primaryColumnType = table.GetColumn(table.PrimaryKey.Columns[0]).ColumnType;
classInfo.CreateMember(table.PrimaryKey.Columns[0], DBColumn.GetType(primaryColumnType),
    new KeyAttribute(IsAutoGenerationSupported(primaryColumnType)));

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

{
    XPMemberInfo mi = info.CreateMember(c.Name, DBColumn.GetType(c.ColumnType));
    if (key == c.Name)

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

protected override XPMemberInfo CreateMemberCore(XPClassInfo owner) {
    return owner.CreateMember(Name, Type.GetType(TypeName, true));
}

VB.NET

asp-net-mvc-grid-custom-binding-and-xpo/VB/XPCustomBindingExample/XPO/DatabaseSchemaHelper.vb#L15

Dim ordersTable As XPClassInfo = dictionary.CreateClass("Order")
ordersTable.CreateMember("ID", GetType(Integer), New KeyAttribute(True))
ordersTable.CreateMember("ProductName", GetType(String))

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

For Each c As DBColumn In table.Columns
    Dim mi As XPMemberInfo = info.CreateMember(c.Name, DBColumn.GetType(c.ColumnType))
    If key = c.Name Then

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

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