EntityTypeConfiguration<TEntityType> Class

Reference

Definition

Namespace:: Microsoft.AspNet.OData.Builder

Assembly:: Microsoft.AspNet.OData.dll

Assembly:: Microsoft.AspNetCore.OData.dll

Package:: Microsoft.AspNet.OData v7.5.8

Package:: Microsoft.AspNetCore.OData v7.5.8

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents an IEdmEntityType that can be built using ODataModelBuilder.

public class EntityTypeConfiguration<TEntityType> : Microsoft.AspNet.OData.Builder.StructuralTypeConfiguration<TEntityType> where TEntityType : class

type EntityTypeConfiguration<'EntityType (requires 'EntityType : null)> = class
    inherit StructuralTypeConfiguration<'EntityType (requires 'EntityType : null)>

Public Class EntityTypeConfiguration(Of TEntityType)
Inherits StructuralTypeConfiguration(Of TEntityType)

Type Parameters

TEntityType

The backing CLR type for this IEdmEntityType.

Inheritance: Object

StructuralTypeConfiguration<TEntityType>
EntityTypeConfiguration<TEntityType>

Properties

BaseType	Gets the base type of this entity type.
Collection	Used to access a Collection of Entities through which you can configure actions and functions that are bindable to EntityCollections.
FullName	Gets the full name of this EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
IsOpen	Gets an indicator whether this EDM type is an open type or not. Returns `true` if this is an open type; `false` otherwise. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Name	Gets and sets the name of this EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Namespace	Gets and sets the namespace of this EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
NavigationProperties	Gets the collection of NavigationPropertyConfiguration of this entity type.
Properties	Gets the collection of EDM structural properties that belong to this type. (Inherited from StructuralTypeConfiguration<TStructuralType>)

Methods

Abstract()	Marks this entity type as abstract.
Action(String)	Create an Action that binds to this EntityType.
CollectionProperty<TElementType>(Expression<Func<TStructuralType,IEnumerable<TElementType>>>)	Adds a collection property to the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
ComplexProperty<TComplexType>(Expression<Func<TStructuralType,TComplexType>>)	Adds a complex property to the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
ContainsMany<TTargetEntity>(Expression<Func<TStructuralType,IEnumerable<TTargetEntity>>>)	Configures a relationship from this structural type to a contained collection navigation property. (Inherited from StructuralTypeConfiguration<TStructuralType>)
ContainsOptional<TTargetEntity>(Expression<Func<TStructuralType,TTargetEntity>>)	Configures an optional relationship from this structural type to a single contained navigation property. (Inherited from StructuralTypeConfiguration<TStructuralType>)
ContainsRequired<TTargetEntity>(Expression<Func<TStructuralType,TTargetEntity>>)	Configures a required relationship from this structural type to a single contained navigation property. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Count()	Sets this property is countable of this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Count(QueryOptionSetting)	Sets whether this property is countable of this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
DerivesFrom<TBaseType>()	Sets the base type of this entity type.
DerivesFromNothing()	Sets the base type of this entity type to `null` meaning that this entity type does not derive from anything.
EnumProperty<T>(Expression<Func<TStructuralType,Nullable<T>>>)	Adds an optional enum property to the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
EnumProperty<T>(Expression<Func<TStructuralType,T>>)	Adds a required enum property to the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Expand()	Sets all properties expandable of this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Expand(Int32)	Sets all properties expandable with maximum depth of expand result of this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Expand(Int32, SelectExpandType, String[])	Sets the maximum depth of expand result, expandable properties and their SelectExpandType of this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Expand(Int32, String[])	Sets the maximum depth of expand result, expandable properties of this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Expand(SelectExpandType)	Sets SelectExpandType of all properties of this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Expand(SelectExpandType, Int32)	Sets SelectExpandType of all properties with maximum depth of expand result of this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Expand(SelectExpandType, String[])	Sets the expandable properties and their SelectExpandType of this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Expand(String[])	Sets the expandable properties of this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Filter()	Sets all properties of this structural type is filterable. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Filter(QueryOptionSetting)	Sets whether all properties of this structural type is filterable. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Filter(QueryOptionSetting, String[])	Sets filterable properties depends on QueryOptionSetting of this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Filter(String[])	Sets filterable properties of this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Function(String)	Create a Function that binds to this EntityType.
HasDynamicProperties(Expression<Func<TStructuralType,IDictionary<String,Object>>>)	Adds a dynamic property dictionary property. (Inherited from StructuralTypeConfiguration<TStructuralType>)
HasInstanceAnnotations(Expression<Func<TStructuralType,IODataInstanceAnnotationContainer>>)	Adds an InstanceAnnotation container property. (Inherited from StructuralTypeConfiguration<TStructuralType>)
HasKey<TKey>(Expression<Func<TEntityType,TKey>>)	Configures the key property(s) for this entity type.
HasMany<TTargetEntity>(Expression<Func<TStructuralType,IEnumerable<TTargetEntity>>>)	Configures a many relationship from this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
HasOptional<TTargetEntity>(Expression<Func<TStructuralType,TTargetEntity>>)	Configures an optional relationship from this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
HasOptional<TTargetEntity>(Expression<Func<TStructuralType,TTargetEntity>>, Expression<Func<TStructuralType,TTargetEntity,Boolean>>)	Configures an optional relationship with referential constraint from this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
HasOptional<TTargetEntity>(Expression<Func<TStructuralType,TTargetEntity>>, Expression<Func<TStructuralType,TTargetEntity,Boolean>>, Expression<Func<TTargetEntity, IEnumerable<TStructuralType>>>)	Configures an optional relationship with referential constraint from this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
HasOptional<TTargetEntity>(Expression<Func<TStructuralType,TTargetEntity>>, Expression<Func<TStructuralType,TTargetEntity,Boolean>>, Expression<Func<TTargetEntity, TStructuralType>>)	Configures an optional relationship with referential constraint from this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
HasRequired<TTargetEntity>(Expression<Func<TStructuralType,TTargetEntity>>)	Configures a required relationship from this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
HasRequired<TTargetEntity>(Expression<Func<TStructuralType,TTargetEntity>>, Expression<Func<TStructuralType,TTargetEntity,Boolean>>)	Configures a required relationship with referential constraint from this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
HasRequired<TTargetEntity>(Expression<Func<TStructuralType,TTargetEntity>>, Expression<Func<TStructuralType,TTargetEntity,Boolean>>, Expression<Func<TTargetEntity, IEnumerable<TStructuralType>>>)	Configures a required relationship with referential constraint from this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
HasRequired<TTargetEntity>(Expression<Func<TStructuralType,TTargetEntity>>, Expression<Func<TStructuralType,TTargetEntity,Boolean>>, Expression<Func<TTargetEntity, TStructuralType>>)	Configures a required relationship with referential constraint from this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Ignore<TProperty>(Expression<Func<TStructuralType,TProperty>>)	Excludes a property from the type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
MediaType()	Marks this entity type as media type.
OrderBy()	Sets all properties of this structural type is sortable. (Inherited from StructuralTypeConfiguration<TStructuralType>)
OrderBy(QueryOptionSetting)	Sets whether all properties of this structural type is sortable. (Inherited from StructuralTypeConfiguration<TStructuralType>)
OrderBy(QueryOptionSetting, String[])	Sets sortable properties depends on QueryOptionSetting of this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
OrderBy(String[])	Sets sortable properties of this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Page()	Sets the properties of this structural type enable paging. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Page(Nullable<Int32>, Nullable<Int32>)	Sets the max value of $top of this structural type that a client can request and the maximum number of query results of this entity type to return. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Property(Expression<Func<TStructuralType,Byte[]>>)	Adds a binary property to the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Property(Expression<Func<TStructuralType,DateTimeOffset>>)	Adds an datetime-with-offset primitive property to the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Property(Expression<Func<TStructuralType,Decimal>>)	Adds an deciaml primitive property to the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Property(Expression<Func<TStructuralType,Nullable<DateTimeOffset>>>)	Adds an datetime-with-offset primitive property to the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Property(Expression<Func<TStructuralType,Nullable<Decimal>>>)	Adds an deciaml primitive property to the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Property(Expression<Func<TStructuralType,Nullable<TimeOfDay>>>)	Adds an time-of-day primitive property to the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Property(Expression<Func<TStructuralType,Nullable<TimeSpan>>>)	Adds an duration primitive property to the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Property(Expression<Func<TStructuralType,Stream>>)	Adds a stream property the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Property(Expression<Func<TStructuralType,String>>)	Adds a string property to the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Property(Expression<Func<TStructuralType,TimeOfDay>>)	Adds an time-of-day primitive property to the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Property(Expression<Func<TStructuralType,TimeSpan>>)	Adds an duration primitive property to the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Property<T>(Expression<Func<TStructuralType,Nullable<T>>>)	Adds an optional primitive property to the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Property<T>(Expression<Func<TStructuralType,T>>)	Adds a required primitive property to the EDM type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Select()	Sets all properties of this structural type is selectable. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Select(SelectExpandType)	Sets SelectExpandType of all properties of this structural type is selectable. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Select(SelectExpandType, String[])	Sets selectable properties depends on SelectExpandType of this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)
Select(String[])	Sets selectable properties of this structural type. (Inherited from StructuralTypeConfiguration<TStructuralType>)

Applies to