Back to Devexpress

IObjectSpace.GetKeyValueAsString(Object) Method

expressappframework-devexpress-dot-expressapp-dot-iobjectspace-dot-getkeyvalueasstring-x28-system-dot-object-x29.md

latest4.7 KB
Original Source

IObjectSpace.GetKeyValueAsString(Object) Method

Returns the key property’s value of the specified object, converted to a string representation.

Namespace : DevExpress.ExpressApp

Assembly : DevExpress.ExpressApp.v25.2.dll

NuGet Package : DevExpress.ExpressApp

Declaration

csharp
string GetKeyValueAsString(
    object obj
)
vb
Function GetKeyValueAsString(
    obj As Object
) As String

Parameters

NameTypeDescription
objObject

An object whose key property value is requested.

|

Returns

TypeDescription
String

A string which is the value of the specified object’s key property.

|

Remarks

When implementing the IObjectSpace interface in the BaseObjectSpace class’s descendant, don’t implement the GetKeyValueAsString method. It’s implemented in the BaseObjectSpace class. The BaseObjectSpace.GetKeyValueAsString method returns null, but it is virtual. So, you should override it in your descendant.

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetKeyValueAsString(Object) 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.

XAF_how-to-connect-different-data-models-to-several-databases-within-a-single-application/CS/XPO/.NetFramework/CommonModule/DatabaseUpdate/Updater.cs#L41

csharp
ObjectSpace.CommitChanges(); //This line persists created object(s).
    ((ISecurityUserWithLoginInfo)sampleUser).CreateUserLoginInfo(SecurityDefaults.PasswordAuthentication, ObjectSpace.GetKeyValueAsString(sampleUser));
}

CriteriaOperatorsCheatSheet/CS/CheatSheetXAF/CriteriaOperatorCheatSheetXAF.Module/DatabaseUpdate/Updater.cs#L40

csharp
ObjectSpace.CommitChanges(); //This line persists created object(s).
    ((ISecurityUserWithLoginInfo)sampleUser).CreateUserLoginInfo(SecurityDefaults.PasswordAuthentication, ObjectSpace.GetKeyValueAsString(sampleUser));
}

XAF_logon-form-manage-users-register-a-new-user-restore-a-password/CS/Security.Extensions/Services/RestorePasswordService.cs#L47

csharp
var token = new RestorePasswordToken() {
    UserId = nonSecuredObjectSpace.GetKeyValueAsString(user)
};

XAF_how-to-connect-different-data-models-to-several-databases-within-a-single-application/VB/CommonModule/DatabaseUpdate/Updater.vb#L45

vb
ObjectSpace.CommitChanges() 'This line persists created object(s).
    CType(sampleUser, ISecurityUserWithLoginInfo).CreateUserLoginInfo(SecurityDefaults.PasswordAuthentication, ObjectSpace.GetKeyValueAsString(sampleUser))
End If

See Also

GetKeyValue(Object)

IObjectSpace Interface

IObjectSpace Members

DevExpress.ExpressApp Namespace