IXPSimpleObject Interface

The interface that provides the basic functionality required by persistent objects.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v22.1.dll

Declaration

C#

public interface IXPSimpleObject :
    IXPClassInfoAndSessionProvider,
    IXPClassInfoProvider,
    IXPDictionaryProvider,
    ISessionProvider,
    IObjectLayerProvider,
    IDataLayerProvider

VB.NET

Public Interface IXPSimpleObject
    Inherits IXPClassInfoAndSessionProvider,
             IXPClassInfoProvider,
             IXPDictionaryProvider,
             ISessionProvider,
             IObjectLayerProvider,
             IDataLayerProvider

Remarks

To make any object persistent (so that it can be stored to/restored from a data store) you can implement the IXPSimpleObject interface for a custom object. You can also implement the IXPObject interface instead, if you need to have more control over the object’s lifetime.

The base class that implements the IXPObject interface is XPBaseObject. So, rather than implementing the IXPSimpleObject or IXPObject interface for a custom object, you can inherit it from the XPBaseObject class, or one of its descendants.

It’s also possible to make any object persistent, by using the PersistentAttribute attribute.

Note

When implementing the IXPSimpleObject interface, it is recommended that you implement a constructor that takes a Session parameter.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the IXPSimpleObject interface.

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#

XAF_treelisteditor-how-to-enable-in-place-editing-in-the-winforms-tree-list-view-xpo-e443/CS/WinSolution.Module.Win/TreeListInplaceEditViewController.cs#L70

IGridInplaceEdit activeEditor = treeList.ActiveEditor as IGridInplaceEdit;
if (activeEditor != null && treeList.FocusedObject is IXPSimpleObject) {
    activeEditor.GridEditingObject = treeList.FocusedObject;

XAF_how-to-use-the-file-attachment-module-with-a-legacy-database-t237508/CS/CustomFileDataSolution.Module/BusinessObjects/InplaceFileData.cs#L17

public class InplaceFileData : IFileData {
    private IXPSimpleObject host;
    private XPMemberInfo member;

XPO_how-to-clone-a-persistent-object-e804/CS/SimpleObject/CloneHelper.cs#L66

XPBaseCollection colSource = (XPBaseCollection)memberInfo.GetValue(source);
foreach (IXPSimpleObject obj in colSource) {
    colTarget.BaseAdd(CloneValue(obj, synchronize, !memberInfo.IsManyToMany));

XPO_how-to-implement-odata4-service-with-xpo/CS/ODataService/Global.asax.cs#L22

public override bool ShouldValidateType(Type type) {
    return persistentTypes.GetOrAdd(type, t => !typeof(IXPSimpleObject).IsAssignableFrom(t));
}

VB.NET

XAF_treelisteditor-how-to-enable-in-place-editing-in-the-winforms-tree-list-view-xpo-e443/VB/WinSolution.Module.Win/TreeListInplaceEditViewController.vb#L73

Dim activeEditor As IGridInplaceEdit = TryCast(treeList.ActiveEditor, IGridInplaceEdit)
If activeEditor IsNot Nothing AndAlso TypeOf treeList.FocusedObject Is IXPSimpleObject Then
    activeEditor.GridEditingObject = treeList.FocusedObject

XAF_how-to-use-the-file-attachment-module-with-a-legacy-database-t237508/VB/CustomFileDataSolution.Module/BusinessObjects/InplaceFileData.vb#L19

Implements IFileData
Private host As IXPSimpleObject
Private member As XPMemberInfo

XPO_how-to-clone-a-persistent-object-e804/VB/SimpleObject/CloneHelper.vb#L69

Dim colSource As XPBaseCollection = CType(memberInfo.GetValue(source), XPBaseCollection)
For Each obj As IXPSimpleObject In colSource
    colTarget.BaseAdd(CloneValue(obj, synchronize, (Not memberInfo.IsManyToMany)))