NavigationPropertyConfiguration Class

Article
10/28/2015

Represents the configuration for a navigation property of an entity type.

Namespace: System.Web.OData.Builder
Assembly: System.Web.OData (in System.Web.OData.dll)

Inheritance Hierarchy

System.Object
System.Web.OData.Builder.PropertyConfiguration
System.Web.OData.Builder.NavigationPropertyConfiguration

Syntax

public class NavigationPropertyConfiguration : PropertyConfiguration

public ref class NavigationPropertyConfiguration : PropertyConfiguration

type NavigationPropertyConfiguration = 
    class
        inherit PropertyConfiguration
    end

Public Class NavigationPropertyConfiguration
    Inherits PropertyConfiguration

Constructors

	Name	Description
	NavigationPropertyConfiguration(PropertyInfo, EdmMultiplicity, EntityTypeConfiguration)	Initializes a new instance of the NavigationPropertyConfiguration class.

Properties

	Name	Description
	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.
	DeclaringEntityType	Gets the declaring entity type.
	DeclaringType	Gets the declaring type.(Inherited from PropertyConfiguration.)
	DependentProperties	Gets the foreign keys in the referential constraint of this navigation property.
	IsRestricted	Gets whether the property is restricted, i.e. not filterable, not sortable, not navigable, not expandable, or not countable.(Inherited from PropertyConfiguration.)
	Kind	Gets the PropertyKind of this property. (Overrides PropertyConfiguration.Kind.)
	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.
	PrincipalProperties	Gets the target keys in the referential constraint of this navigation property.
	PropertyInfo	Gets the mapping CLR PropertyInfo.(Inherited from PropertyConfiguration.)
	RelatedClrType	Gets the backing CLR type of this property type. (Overrides PropertyConfiguration.RelatedClrType.)
	Unsortable	Gets or sets whether the property is unsortable. default is false.(Inherited from PropertyConfiguration.)

Methods

	Name	Description
	AutomaticallyExpand()	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.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	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 .
	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.)
	MemberwiseClone()	(Inherited from Object.)
	NonContained()	Marks the navigation property as non-contained.
	Optional()	Marks the navigation property as optional.
	Required()	Marks the navigation property as required.
	ToString()	(Inherited from Object.)

Remarks

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

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via