NavigationPropertyConfiguration 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 the configuration for a navigation property of a structural type.

public class NavigationPropertyConfiguration : Microsoft.AspNet.OData.Builder.PropertyConfiguration

type NavigationPropertyConfiguration = class
    inherit PropertyConfiguration

Public Class NavigationPropertyConfiguration
Inherits PropertyConfiguration

Inheritance: Object

PropertyConfiguration
NavigationPropertyConfiguration

Remarks

This configuration functionality is exposed by the model builder Fluent API, see ODataModelBuilder.

Constructors

NavigationPropertyConfiguration(PropertyInfo, EdmMultiplicity, StructuralTypeConfiguration)

Initializes a new instance of the NavigationPropertyConfiguration class.

Properties

AddedExplicitly	Gets or sets a value that is `true` if the property was added by the user; `false` if it was inferred through conventions. (Inherited from PropertyConfiguration)
AutoExpand	Gets or sets whether the property is automatically expanded. default is false. (Inherited from PropertyConfiguration)
ContainsTarget	Gets whether this navigation property is a containment, default to false.
DeclaringType	Gets the declaring type. (Inherited from PropertyConfiguration)
DependentProperties	Gets the foreign keys in the referential constraint of this navigation property.
DerivedTypeConstraints	List of allowed derived types that are allowed for the property. (Inherited from PropertyConfiguration)
DisableAutoExpandWhenSelectIsPresent	Gets or sets whether the automatic expand will be disabled if there is a $select specify by client. (Inherited from PropertyConfiguration)
IsRestricted	Gets whether the property is restricted, i.e. not filterable, not sortable, not navigable, not expandable, not countable, or automatically expand. (Inherited from PropertyConfiguration)
Kind	Gets the PropertyKind of this property.
Multiplicity	Gets the EdmMultiplicity of this navigation property.
Name	Gets or sets the name of the property. (Inherited from PropertyConfiguration)
NonFilterable	Gets or sets whether the property is nonfilterable. default is false. (Inherited from PropertyConfiguration)
NotCountable	Gets or sets whether the property is not countable. default is false. (Inherited from PropertyConfiguration)
NotExpandable	Gets or sets whether the property is not expandable. default is false. (Inherited from PropertyConfiguration)
NotFilterable	Gets or sets whether the property is not filterable. default is false. (Inherited from PropertyConfiguration)
NotNavigable	Gets or sets whether the property is not navigable. default is false. (Inherited from PropertyConfiguration)
NotSortable	Gets or sets whether the property is not sortable. default is false. (Inherited from PropertyConfiguration)
OnDeleteAction	Gets or sets the delete action for this navigation property.
Order	Get or sets order in "order by" expression. (Inherited from PropertyConfiguration)
Partner	The partner relationship of this navigation property.
PrincipalProperties	Gets the target keys in the referential constraint of this navigation property.
PropertyInfo	Gets the mapping CLR PropertyInfo. (Inherited from PropertyConfiguration)
QueryConfiguration	Gets or sets the QueryConfiguration. (Inherited from PropertyConfiguration)
RelatedClrType	Gets the backing CLR type of this property type.
Unsortable	Gets or sets whether the property is unsortable. default is false. (Inherited from PropertyConfiguration)

Methods

AutomaticallyExpand(Boolean)	Marks the navigation property is automatic expanded.
CascadeOnDelete()	Configures cascade delete to be on for the navigation property.
CascadeOnDelete(Boolean)	Configures whether or not cascade delete is on for the navigation property.
Contained()	Marks the navigation property as containment.
Count()	Sets this property is countable. (Inherited from PropertyConfiguration)
Count(QueryOptionSetting)	Sets whether this property is countable. (Inherited from PropertyConfiguration)
Expand()	Sets all properties expandable. (Inherited from PropertyConfiguration)
Expand(Int32, SelectExpandType, String[])	Sets the maximum depth of expand result, expandable properties and their SelectExpandType of this navigation property. (Inherited from PropertyConfiguration)
Expand(Int32, String[])	Sets the maximum depth of expand result, expandable properties of this navigation property. (Inherited from PropertyConfiguration)
Expand(Int32)	Sets all properties expandable with maximum depth of expand result. (Inherited from PropertyConfiguration)
Expand(SelectExpandType, Int32)	Sets SelectExpandType of all properties with maximum depth of expand result. (Inherited from PropertyConfiguration)
Expand(SelectExpandType, String[])	Sets the expandable properties and their SelectExpandType of this navigation property. (Inherited from PropertyConfiguration)
Expand(SelectExpandType)	Sets SelectExpandType of all properties. (Inherited from PropertyConfiguration)
Expand(String[])	Sets the expandable properties of this navigation property. (Inherited from PropertyConfiguration)
Filter()	Sets all properties of this property is filterable. (Inherited from PropertyConfiguration)
Filter(QueryOptionSetting, String[])	Sets filterable properties depends on QueryOptionSetting of this property. (Inherited from PropertyConfiguration)
Filter(QueryOptionSetting)	Sets whether all properties of this property is filterable. (Inherited from PropertyConfiguration)
Filter(String[])	Sets filterable properties of this property. (Inherited from PropertyConfiguration)
HasConstraint(KeyValuePair<PropertyInfo,PropertyInfo>)	Configures the referential constraint with the dependent and principal property pair.
HasConstraint(PropertyInfo, PropertyInfo)	Configures the referential constraint with the specified and .
HasDerivedTypeConstraint<TDerivedType>()	Adds TDerivedType to the list of derived type constraints.
HasDerivedTypeConstraints(Type[])	Adds subtypes to the list of derived type constraints.
IsCountable()	Sets the property as countable. (Inherited from PropertyConfiguration)
IsExpandable()	Sets the property as expandable. (Inherited from PropertyConfiguration)
IsFilterable()	Sets the property as filterable. (Inherited from PropertyConfiguration)
IsNavigable()	Sets the property as navigable. (Inherited from PropertyConfiguration)
IsNonFilterable()	Sets the property as nonfilterable. (Inherited from PropertyConfiguration)
IsNotCountable()	Sets the property as not countable. (Inherited from PropertyConfiguration)
IsNotExpandable()	Sets the property as not expandable. (Inherited from PropertyConfiguration)
IsNotFilterable()	Sets the property as not filterable. (Inherited from PropertyConfiguration)
IsNotNavigable()	Sets the property as not navigable. (Inherited from PropertyConfiguration)
IsNotSortable()	Sets the property as not sortable. (Inherited from PropertyConfiguration)
IsSortable()	Sets the property as sortable. (Inherited from PropertyConfiguration)
IsUnsortable()	Sets the property as unsortable. (Inherited from PropertyConfiguration)
NonContained()	Marks the navigation property as non-contained.
Optional()	Marks the navigation property as optional.
OrderBy()	Sets all properties of this property is sortable. (Inherited from PropertyConfiguration)
OrderBy(QueryOptionSetting, String[])	Sets sortable properties depends on QueryOptionSetting of this property. (Inherited from PropertyConfiguration)
OrderBy(QueryOptionSetting)	Sets whether all properties of this property is sortable. (Inherited from PropertyConfiguration)
OrderBy(String[])	Sets sortable properties of this property. (Inherited from PropertyConfiguration)
Page()	Sets this property enable paging. (Inherited from PropertyConfiguration)
Page(Nullable<Int32>, Nullable<Int32>)	Sets the max value of $top of this property that a client can request and the maximum number of query results of this property to return. (Inherited from PropertyConfiguration)
Required()	Marks the navigation property as required.
Select()	Sets all properties of this property is selectable. (Inherited from PropertyConfiguration)
Select(SelectExpandType, String[])	Sets selectable properties depends on SelectExpandType of this property. (Inherited from PropertyConfiguration)
Select(SelectExpandType)	Sets SelectExpandType of all properties of this property is selectable. (Inherited from PropertyConfiguration)
Select(String[])	Sets selectable properties of this property. (Inherited from PropertyConfiguration)

Applies to

Jaa