Skip to main content
BuyLog In
eXpressApp Framework
Search in…
Docs > Storage, ORM, and Business Model Design > Data Types Supported by built-in Editors > Key Properties
All docs
V23.1
.NET Framework 4.5.2+
Cross-Platform .NET App UI (XAF)
Getting Started
Installation, Upgrade, Version History
Backend Web API Service
UI Shell and Base Infrastructure
Storage, ORM, and Business Model Design
Why We Recommend EF Core over XPO for New Development
Business Model Design with Entity Framework Core
Business Model Design with XPO
Non-Persistent Objects
The Importance of Property Change Notifications
Built-in Business Classes & Interfaces
Ways to Add a Business Class
Data Types Supported by built-in Editors
Key Properties
String Properties
Numeric Properties
Date and Time Properties
Boolean Properties
BLOB Image Properties
Collection Properties
Reference (Foreign Key, Complex Type) Properties
File Attachment Properties
Type Properties
Enumeration Properties
Criteria Properties
Color Properties
Geolocation Properties
Miscellaneous Property Types
Mapping Complex Types to the Database
Types Info Subsystem
Connect an XAF Application to a Database Provider
Data Annotation Attributes
Create and Update the Application's Database
How to: Specify a Display Member for a Lookup Editor, Detail Form Caption, and more
Data Manipulation and Business Logic
User Interface and Behavior Customization
Data Filtering
Data Security and Safety
Multitenancy Support (CTP)
Validation (Prevent Data Errors)
Conditional Appearance (Manage State of UI Elements)
Reporting (Shape, Export & Print Data)
Analytics (Extract Data Insights)
Document Management
Business Process Management
Event Planning
Localization
Security Consideration
Debugging, Testing and Error Handling
Deployment
Support, QA & Troubleshooting
API Reference
Download CHM

Key Properties

  • 2 minutes to read

One of the XAF’s functions is managing a database via an ORM tool. Dealing with the database assumes that each object has a property that allows you to distinguish an object among other objects of the same type. In relational databases, such property is called a Unique key (primary key or a key). Each business class you create with an ORM tool must have a key property that will be used as a database unique key. Key property implementation differs, depending on the specific data access technology you use.

Entity Framework (EF)

When using EF, you can implement a key property by one of the following ways.

  • Implement a property named “Id”
  • Implement a property that combines the class name and “Id”, such as “ContactId” (assuming that your class name is “Contact”)
  • Decorate any property with the Key Attribute
  • Inherit your class from the DevExpress.Persistent.BaseImpl.EF.BaseObject class that has the Guid key property.

For detailed information, refer to the Keys Microsoft article.

eXpress Persistent Objects (XPO)

In most XPO cases, you needn’t be concerned with the key property, because usually it is already implemented in a class that is used as the base for your own XPO business class. Refer to the Base Persistent Classes article for more information about different base classes to inherit from and their key properties.

If you need to implement your own key property, inherit your new class from one of the Base Persistent Classes without a key (XPLiteObject, XPBaseObject or XPCustomObject), implement a key property manually, then decorate it with the KeyAttribute.

Note

We do not recommend implementing composite or compound keys for new databases. While it is possible to design persistent classes for legacy databases with composite keys in certain scenarios, it is always better to modify the database schema to avoid this as using composite keys imposes some limitations on the default functionality. Refer to the How to create a persistent object for a database table with a compound key KB article to learn more. If you use compound keys in an ASP.NET Web Forms application, decorate the struct key property with the TypeConverterAttribute as described in the StructTypeConverter<T> article. Also, note that the user-friendly URL mechanism does not support composite keys. Implement a custom ViewUrlManager to support them.