StructuralTypeConfiguration<TStructuralType> 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 IEdmStructuredType that can be built using ODataModelBuilder.

public abstract class StructuralTypeConfiguration<TStructuralType> where TStructuralType : class

type StructuralTypeConfiguration<'StructuralType (requires 'StructuralType : null)> = class

Public MustInherit Class StructuralTypeConfiguration(Of TStructuralType)

Type Parameters

TStructuralType

Inheritance: Object
StructuralTypeConfiguration<TStructuralType>

Derived: Microsoft.AspNet.OData.Builder.ComplexTypeConfiguration<TComplexType>

Microsoft.AspNet.OData.Builder.EntityTypeConfiguration<TEntityType>

Constructors

StructuralTypeConfiguration<TStructuralType>(StructuralTypeConfiguration)

Initializes a new instance of the StructuralTypeConfiguration<TStructuralType> class.

Properties

FullName	Gets the full name of this EDM type.
IsOpen	Gets an indicator whether this EDM type is an open type or not. Returns `true` if this is an open type; `false` otherwise.
Name	Gets and sets the name of this EDM type.
Namespace	Gets and sets the namespace of this EDM type.
Properties	Gets the collection of EDM structural properties that belong to this type.

Methods

CollectionProperty<TElementType>(Expression<Func<TStructuralType,IEnumerable<TElementType>>>)	Adds a collection property to the EDM type.
ComplexProperty<TComplexType>(Expression<Func<TStructuralType,TComplexType>>)	Adds a complex property to the EDM type.
ContainsMany<TTargetEntity>(Expression<Func<TStructuralType,IEnumerable<TTargetEntity>>>)	Configures a relationship from this structural type to a contained collection navigation property.
ContainsOptional<TTargetEntity>(Expression<Func<TStructuralType,TTargetEntity>>)	Configures an optional relationship from this structural type to a single contained navigation property.
ContainsRequired<TTargetEntity>(Expression<Func<TStructuralType,TTargetEntity>>)	Configures a required relationship from this structural type to a single contained navigation property.
Count()	Sets this property is countable of this structural type.
Count(QueryOptionSetting)	Sets whether this property is countable of this structural type.
EnumProperty<T>(Expression<Func<TStructuralType,Nullable<T>>>)	Adds an optional enum property to the EDM type.
EnumProperty<T>(Expression<Func<TStructuralType,T>>)	Adds a required enum property to the EDM type.
Expand()	Sets all properties expandable of this structural type.
Expand(Int32, SelectExpandType, String[])	Sets the maximum depth of expand result, expandable properties and their SelectExpandType of this structural type.
Expand(Int32, String[])	Sets the maximum depth of expand result, expandable properties of this structural type.
Expand(Int32)	Sets all properties expandable with maximum depth of expand result of this structural type.
Expand(SelectExpandType, Int32)	Sets SelectExpandType of all properties with maximum depth of expand result of this structural type.
Expand(SelectExpandType, String[])	Sets the expandable properties and their SelectExpandType of this structural type.
Expand(SelectExpandType)	Sets SelectExpandType of all properties of this structural type.
Expand(String[])	Sets the expandable properties of this structural type.
Filter()	Sets all properties of this structural type is filterable.
Filter(QueryOptionSetting, String[])	Sets filterable properties depends on QueryOptionSetting of this structural type.
Filter(QueryOptionSetting)	Sets whether all properties of this structural type is filterable.
Filter(String[])	Sets filterable properties of this structural type.
HasDynamicProperties(Expression<Func<TStructuralType,IDictionary<String,Object>>>)	Adds a dynamic property dictionary property.
HasInstanceAnnotations(Expression<Func<TStructuralType,IODataInstanceAnnotationContainer>>)	Adds an InstanceAnnotation container property.
HasMany<TTargetEntity>(Expression<Func<TStructuralType,IEnumerable<TTargetEntity>>>)	Configures a many relationship from this structural type.
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.
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.
HasOptional<TTargetEntity>(Expression<Func<TStructuralType,TTargetEntity>>, Expression<Func<TStructuralType,TTargetEntity,Boolean>>)	Configures an optional relationship with referential constraint from this structural type.
HasOptional<TTargetEntity>(Expression<Func<TStructuralType,TTargetEntity>>)	Configures an optional relationship from this structural type.
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.
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.
HasRequired<TTargetEntity>(Expression<Func<TStructuralType,TTargetEntity>>, Expression<Func<TStructuralType,TTargetEntity,Boolean>>)	Configures a required relationship with referential constraint from this structural type.
HasRequired<TTargetEntity>(Expression<Func<TStructuralType,TTargetEntity>>)	Configures a required relationship from this structural type.
Ignore<TProperty>(Expression<Func<TStructuralType,TProperty>>)	Excludes a property from the type.
OrderBy()	Sets all properties of this structural type is sortable.
OrderBy(QueryOptionSetting, String[])	Sets sortable properties depends on QueryOptionSetting of this structural type.
OrderBy(QueryOptionSetting)	Sets whether all properties of this structural type is sortable.
OrderBy(String[])	Sets sortable properties of this structural type.
Page()	Sets the properties of this structural type enable paging.
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.
Property(Expression<Func<TStructuralType,Byte[]>>)	Adds a binary property to the EDM type.
Property(Expression<Func<TStructuralType,DateTimeOffset>>)	Adds an datetime-with-offset primitive property to the EDM type.
Property(Expression<Func<TStructuralType,Decimal>>)	Adds an deciaml primitive property to the EDM type.
Property(Expression<Func<TStructuralType,Nullable<DateTimeOffset>>>)	Adds an datetime-with-offset primitive property to the EDM type.
Property(Expression<Func<TStructuralType,Nullable<Decimal>>>)	Adds an deciaml primitive property to the EDM type.
Property(Expression<Func<TStructuralType,Nullable<TimeOfDay>>>)	Adds an time-of-day primitive property to the EDM type.
Property(Expression<Func<TStructuralType,Nullable<TimeSpan>>>)	Adds an duration primitive property to the EDM type.
Property(Expression<Func<TStructuralType,Stream>>)	Adds a stream property the EDM type.
Property(Expression<Func<TStructuralType,String>>)	Adds a string property to the EDM type.
Property(Expression<Func<TStructuralType,TimeOfDay>>)	Adds an time-of-day primitive property to the EDM type.
Property(Expression<Func<TStructuralType,TimeSpan>>)	Adds an duration primitive property to the EDM type.
Property<T>(Expression<Func<TStructuralType,Nullable<T>>>)	Adds an optional primitive property to the EDM type.
Property<T>(Expression<Func<TStructuralType,T>>)	Adds a required primitive property to the EDM type.
Select()	Sets all properties of this structural type is selectable.
Select(SelectExpandType, String[])	Sets selectable properties depends on SelectExpandType of this structural type.
Select(SelectExpandType)	Sets SelectExpandType of all properties of this structural type is selectable.
Select(String[])	Sets selectable properties of this structural type.

Applies to

Share via