CollectionPropertyConfiguration Class

Article
10/28/2015

CollectionPropertyConfiguration represents a CollectionProperty on either an EntityType or ComplexType.

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.StructuralPropertyConfiguration
System.Web.OData.Builder.CollectionPropertyConfiguration

Syntax

public class CollectionPropertyConfiguration : StructuralPropertyConfiguration

public ref class CollectionPropertyConfiguration : StructuralPropertyConfiguration

type CollectionPropertyConfiguration = 
    class
        inherit StructuralPropertyConfiguration
    end

Public Class CollectionPropertyConfiguration
    Inherits StructuralPropertyConfiguration

Constructors

	Name	Description
	CollectionPropertyConfiguration(PropertyInfo, StructuralTypeConfiguration)	Constructs a CollectionPropertyConfiguration using the property provided.

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.)
	ConcurrencyToken	Gets or sets a value indicating whether this property is a concurrency token or not.(Inherited from StructuralPropertyConfiguration.)
	DeclaringType	Gets the declaring type.(Inherited from PropertyConfiguration.)
	ElementType	Returns the type of Elements in the Collection
	IsRestricted	Gets whether the property is restricted, i.e. not filterable, not sortable, not navigable, not expandable, or not countable.(Inherited from PropertyConfiguration.)
	Kind	(Overrides PropertyConfiguration.Kind.)
	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.)
	OptionalProperty	Gets or sets a value indicating whether this property is optional or not.(Inherited from StructuralPropertyConfiguration.)
	PropertyInfo	Gets the mapping CLR PropertyInfo.(Inherited from PropertyConfiguration.)
	RelatedClrType	(Overrides PropertyConfiguration.RelatedClrType.)
	Unsortable	Gets or sets whether the property is unsortable. default is false.(Inherited from PropertyConfiguration.)

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	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.)
	IsOptional()	Sets the CollectionProperty to optional (i.e. nullable).
	IsRequired()	Sets the CollectionProperty to required (i.e. non-nullable).
	IsSortable()	Sets the property as sortable.(Inherited from PropertyConfiguration.)
	IsUnsortable()	Sets the property as unsortable.(Inherited from PropertyConfiguration.)
	MemberwiseClone()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

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