XPClassInfo Class

Serves as a base for classes that provide metadata information for a class.

Namespace: DevExpress.Xpo.Metadata

Assembly: DevExpress.Xpo.v22.1.dll

Declaration

C#

public abstract class XPClassInfo :
    XPTypeInfo,
    IXPClassInfoProvider,
    IXPDictionaryProvider

VB.NET

Public MustInherit Class XPClassInfo
    Inherits XPTypeInfo
    Implements IXPClassInfoProvider,
               IXPDictionaryProvider

Related API Members

The following members return XPClassInfo objects:

Show 41 links

• ObjectsByKeyQuery.ClassInfo
• ObjectsQuery.ClassInfo
• PersistentBase.ClassInfo
• ReflectionClassInfo.BaseClass
• ReflectionDictionary.QueryClassInfo(String, String)
• ReflectionDictionary.QueryClassInfo(Type)
• SchemaInitEventArgs.Table
• Session.GetClassInfo(Object)
• Session.GetClassInfo(String, String)
• Session.GetClassInfo(Type)
• Session.GetClassInfo<ClassType>()
• XPBaseCollection.GetObjectClassInfo()
• XPBaseCollection.GetRealFetchClassInfo()
• XPBindingSource.ObjectClassInfo
• XPClassInfo.BaseClass
• XPClassInfo.IdClass
• XPClassInfo.PersistentBaseClass
• XPCollection.GetObjectClassInfo()
• XPCollection.ObjectClassInfo
• XPCollection<T>.GetObjectClassInfo()
• XPCursor.ObjectClassInfo
• XPCustomMemberInfo.ReferenceType
• XPDataObjectClassInfo.BaseClass
• XPDictionary.CreateClass(String, Attribute[])
• XPDictionary.CreateClass(XPClassInfo, String, Attribute[])
• XPDictionary.GetClassInfo(Object)
• XPDictionary.GetClassInfo(String, String)
• XPDictionary.GetClassInfo(Type)
• XPDictionary.QueryClassInfo(Object)
• XPDictionary.QueryClassInfo(String, String)
• XPDictionary.QueryClassInfo(Type)
• XPMemberInfo.CollectionElementType
• XPMemberInfo.GetMappingClass(XPClassInfo)
• XPMemberInfo.Owner
• XPMemberInfo.ReferenceType
• XPObjectSource.EntityType
• XPObjectType.GetClassInfo()
• XPObjectType.TypeClassInfo
• XPServerCollectionSource.ObjectClassInfo
• XPServerModeView.ObjectClassInfo
• XPView.ObjectClassInfo

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));
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))
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 XPClassInfo class.

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#L10

public class MyBaseObject : XPObject {
    public MyBaseObject(Session session, XPClassInfo classInfo) : base(session, classInfo) { }
}

XPO_how-to-create-persistent-classes-mapped-to-tables-with-a-composite-primary-key-at-runtime-e4606/CS/XpoConsoleApplication/XPComplexCustomMemberInfo.cs#L9

public class XPComplexCustomMemberInfo : XPCustomMemberInfo {
    public XPComplexCustomMemberInfo(XPClassInfo owner, string propertyName, Type propertyType, params Attribute[] attributes)
        : this(owner, propertyName, propertyType, null, false, false, attributes) { }

how-to-bind-an-aspnet-mvc-gridview-extension-to-a-table-with-an-unknown-schema-using-custo-t602001/CS/XPCustomBindingExample/XPO/BasePersistentClass.cs#L8

    public BasePersistentClass(Session session) : base(session) { }
    public BasePersistentClass(Session session, XPClassInfo classInfo) : base(session, classInfo) { }
}

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

private XPClassInfo CreateObject(IDataStore s, string name, Type baseType) {
    DBTable[] tables = ((IDataStoreSchemaExplorer)s).GetStorageTables(name);

XPO_how-to-implement-odata4-service-with-xpo/CS/ODataService/App_Start/WebApiConfig.cs#L39

foreach(var type in ConnectionHelper.GetPersistentTypes()) {
    XPClassInfo classInfo = dictionary.GetClassInfo(type);
    CreateEntitySet(classInfo, builder);

VB.NET

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

Public Sub New(ByVal session As Session, ByVal classInfo As XPClassInfo)
    MyBase.New(session, classInfo)

XPO_how-to-create-persistent-classes-mapped-to-tables-with-a-composite-primary-key-at-runtime-e4606/VB/XpoConsoleApplication/XPComplexCustomMemberInfo.vb#L11

Public Sub New(ByVal owner As XPClassInfo, ByVal propertyName As String, ByVal propertyType As Type, ParamArray ByVal attributes() As Attribute)
    Me.New(owner, propertyName, propertyType, Nothing, False, False, attributes)

how-to-bind-an-aspnet-mvc-gridview-extension-to-a-table-with-an-unknown-schema-using-custo-t602001/VB/XPCustomBindingExample/XPO/BasePersistentClass.vb#L12

End Sub
Public Sub New(ByVal session As Session, ByVal classInfo As XPClassInfo)
    MyBase.New(session, classInfo)

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

Private Function CreateObject(ByVal s As IDataStore, ByVal name As String, ByVal baseType As Type) As XPClassInfo
    Dim tables() As DBTable = (CType(s, IDataStoreSchemaExplorer)).GetStorageTables(name)

XPO_how-to-create-an-xpclassinfo-descendant-to-dynamically-build-a-persistent-class-structure-e1729/VB/DynamicDataTable/DynamicDataTableClassInfo.vb#L9

Public Class DynamicDataTableClassInfo
    Inherits XPClassInfo

Inheritance

Object

XPTypeInfo

XPClassInfo

ReflectionClassInfo

XPDataObjectClassInfo