NShape Reference
GetPropertyDefinitions method

<< Click to Display Table of Contents >>

Navigation:  Class Reference > Namespace Dataweb.NShape.Advanced > IEntity Interface >

NShape Reference
GetPropertyDefinitions method

Previous pageReturn to chapter overviewNext page

Retrieves the persistable properties of an entity type.

Syntax

static IEnumerable<EntityPropertyDefinition> GetPropertyDefinitions(int version)

Description

This method is not a formal part of the IEntity interface, because interfaces cannot include static methods. However, each type implementing IEntity also has to provide the property definitions and preferably uses this signature for the purpose. The enumerator lists the properties of the entity in the sequence they are loaded or saved. A property can either be a field, which is a simple data variable or a so-called inner object, which is a collection of more complex types having property definitions by themselves.

Parameters

Name

Description

version

Format version for which the definitions shall be retrieved.

Return Value

Sequence of entity property definitions as either EntityFieldDefinition or EntityInnerObjectsDefinition.

Exceptions

None