BaseObject.Oid Property

Specifies the persistent object’s identifier.

Namespace: DevExpress.Persistent.BaseImpl

Assembly: DevExpress.Persistent.BaseImpl.Xpo.v24.2.dll

NuGet Package: DevExpress.Persistent.BaseImpl.Xpo

Declaration

C#

[PersistentAlias("oid")]
[VisibleInListView(false)]
[VisibleInDetailView(false)]
[VisibleInLookupListView(false)]
public Guid Oid { get; }

VB.NET

<PersistentAlias("oid")>
<VisibleInListView(False)>
<VisibleInDetailView(False)>
<VisibleInLookupListView(False)>
Public ReadOnly Property Oid As Guid

Property Value

Type	Description
Guid	A globally unique identifier which represents the persistent object’s identifier.

Remarks

To distinguish between different business objects and correctly identify them, the BaseObject class exposes the Oid property. This is an auto-generated property, meaning you do not need to assign identifier values for each persistent object. The Oid property can also be referred to as a primary key property, since it is represented by a primary key in the database.

Note that when OidInitializationMode is set to OnSaving, new persistent objects have Guid.Empty as the Oid property value after they are created. The property gains a final value after the object is saved to the database.

The XPObjectSpace class exposes a number of methods that take the value returned by a business object’s Oid property as a parameter. These methods allow you to find a particular object by its key property value, as well as perform additional actions based on it. The following table lists these methods.

• XPObjectSpace.GetObjectByKey
• BaseObjectSpace.GetKeyPropertyName
• BaseObjectSpace.GetKeyPropertyType
• XPObjectSpace.GetKeyValue
• XPObjectSpace.GetKeyValueAsString

Note

The BaseObject‘s Oid property, as well as other base classes key properties, is not designed to be manually set. In fact, this is not supported and should never be done. Under normal circumstances, the Oid property does not even expose a setter.

Related GitHub Examples

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

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_Non-Persistent-Objects-Nested-In-Persistent-Objects-Demo/CS/NonPersistentObjectsDemo.Module/BusinessObjects/CollectionComplete/Project.cs#L44

var obj = list[e.NewIndex];
obj.OwnerKey = this.Oid;
obj.LocalKey = e.NewIndex + 1;

xaf-web-forms-use-oauth2-authentication-providers/CS/MySolution.Module/DatabaseUpdate/Updater.cs#L81

defaultRole.AddObjectPermissionFromLambda<PermissionPolicyUser>(SecurityOperations.Read, cm => cm.Oid == (Guid)CurrentUserIdOperator.CurrentUserId(), SecurityPermissionState.Allow);
defaultRole.AddNavigationPermission(@"Application/NavigationItems/Items/Default/Items/MyDetails", SecurityPermissionState.Allow);

xaf-custom-logon-parameters/CS/XPO/WebForms/CustomLogonXPOWeb/CustomLogonXPOWeb.Module/DatabaseUpdate/Updater.cs#L98

defaultRole.AddObjectPermissionFromLambda<ApplicationUser>(SecurityOperations.Read, cm => cm.Oid == (Guid)CurrentUserIdOperator.CurrentUserId(), SecurityPermissionState.Allow);
defaultRole.AddNavigationPermission(@"Application/NavigationItems/Items/Default/Items/MyDetails", SecurityPermissionState.Allow);

xaf-win-web-open-detail-view-when-grid-row-is-clicked-in-the-dashboard/CS/ShowDetailViewFromDashboard.Module.Web/Controllers/WebShowDetailViewFromDashboardController.cs#L57

IObjectSpace objectSpace = Application.CreateObjectSpace(typeof(Contact));
Contact contact = objectSpace.FindObject<Contact>(new BinaryOperator(nameof(Contact.Oid), oid));
if (contact != null) {

xaf-how-to-use-data-from-security-in-criterion/CS/CustomFunctionCriteriaOperator.Module/CurrentCompanyOidParameter.cs#L17

public object Evaluate(params object[] operands) {
   return ((Employee)SecuritySystem.CurrentUser).Company.Oid;
}

VB.NET

XAF_Non-Persistent-Objects-Nested-In-Persistent-Objects-Demo/VB/NonPersistentObjectsDemo.Module/BusinessObjects/CollectionComplete/Project.vb#L53

Dim obj = list(e.NewIndex)
obj.OwnerKey = Me.Oid
obj.LocalKey = e.NewIndex + 1

xaf-web-forms-use-oauth2-authentication-providers/VB/MySolution.Module/DatabaseUpdate/Updater.vb#L83

defaultRole.AddObjectPermissionFromLambda(Of PermissionPolicyUser)(SecurityOperations.Read, Function(cm) cm.Oid = DirectCast(CurrentUserIdOperator.CurrentUserId(), Guid), SecurityPermissionState.Allow)
defaultRole.AddNavigationPermission("Application/NavigationItems/Items/Default/Items/MyDetails", SecurityPermissionState.Allow)

xaf-how-to-use-data-from-security-in-criterion/VB/CustomFunctionCriteriaOperator.Module/CurrentCompanyOidParameter.vb#L19

Public Function Evaluate(ByVal ParamArray operands() As Object) As Object Implements ICustomFunctionOperator.Evaluate
    Return CType(SecuritySystem.CurrentUser, Employee).Company.Oid
End Function