PropertyConfiguration Class

Definition

Namespace:

Microsoft.AspNet.OData.Builder

Assembly:

Microsoft.AspNetCore.OData.dll

Package:

Microsoft.AspNetCore.OData v7.5.8

Base class for all property configurations.

public abstract class PropertyConfiguration

type PropertyConfiguration = class

Public MustInherit Class PropertyConfiguration

Inheritance

Object

PropertyConfiguration

Derived

Microsoft.AspNet.OData.Builder.NavigationPropertyConfiguration

Microsoft.AspNet.OData.Builder.StructuralPropertyConfiguration

Constructors

PropertyConfiguration(PropertyInfo, StructuralTypeConfiguration)

Initializes a new instance of the PropertyConfiguration 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.
AutoExpand	Gets or sets whether the property is automatically expanded. default is false.
DeclaringType	Gets the declaring type.
DerivedTypeConstraints	List of allowed derived types that are allowed for the property.
DisableAutoExpandWhenSelectIsPresent	Gets or sets whether the automatic expand will be disabled if there is a $select specify by client.
IsRestricted	Gets whether the property is restricted, i.e. not filterable, not sortable, not navigable, not expandable, not countable, or automatically expand.
Kind	Gets the PropertyKind of the property.
Name	Gets or sets the name of the property.
NonFilterable	Gets or sets whether the property is nonfilterable. default is false.
NotCountable	Gets or sets whether the property is not countable. default is false.
NotExpandable	Gets or sets whether the property is not expandable. default is false.
NotFilterable	Gets or sets whether the property is not filterable. default is false.
NotNavigable	Gets or sets whether the property is not navigable. default is false.
NotSortable	Gets or sets whether the property is not sortable. default is false.
Order	Get or sets order in "order by" expression.
PropertyInfo	Gets the mapping CLR PropertyInfo.
QueryConfiguration	Gets or sets the QueryConfiguration.
RelatedClrType	Gets the CLR Type of the property.
Unsortable	Gets or sets whether the property is unsortable. default is false.

Methods

Count()	Sets this property is countable.
Count(QueryOptionSetting)	Sets whether this property is countable.
Expand()	Sets all properties expandable.
Expand(Int32)	Sets all properties expandable with maximum depth of expand result.
Expand(Int32, SelectExpandType, String[])	Sets the maximum depth of expand result, expandable properties and their SelectExpandType of this navigation property.
Expand(Int32, String[])	Sets the maximum depth of expand result, expandable properties of this navigation property.
Expand(SelectExpandType)	Sets SelectExpandType of all properties.
Expand(SelectExpandType, Int32)	Sets SelectExpandType of all properties with maximum depth of expand result.
Expand(SelectExpandType, String[])	Sets the expandable properties and their SelectExpandType of this navigation property.
Expand(String[])	Sets the expandable properties of this navigation property.
Filter()	Sets all properties of this property is filterable.
Filter(QueryOptionSetting)	Sets whether all properties of this property is filterable.
Filter(QueryOptionSetting, String[])	Sets filterable properties depends on QueryOptionSetting of this property.
Filter(String[])	Sets filterable properties of this property.
IsCountable()	Sets the property as countable.
IsExpandable()	Sets the property as expandable.
IsFilterable()	Sets the property as filterable.
IsNavigable()	Sets the property as navigable.
IsNonFilterable()	Sets the property as nonfilterable.
IsNotCountable()	Sets the property as not countable.
IsNotExpandable()	Sets the property as not expandable.
IsNotFilterable()	Sets the property as not filterable.
IsNotNavigable()	Sets the property as not navigable.
IsNotSortable()	Sets the property as not sortable.
IsSortable()	Sets the property as sortable.
IsUnsortable()	Sets the property as unsortable.
OrderBy()	Sets all properties of this property is sortable.
OrderBy(QueryOptionSetting)	Sets whether all properties of this property is sortable.
OrderBy(QueryOptionSetting, String[])	Sets sortable properties depends on QueryOptionSetting of this property.
OrderBy(String[])	Sets sortable properties of this property.
Page()	Sets this property enable paging.
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.
Select()	Sets all properties of this property is selectable.
Select(SelectExpandType)	Sets SelectExpandType of all properties of this property is selectable.
Select(SelectExpandType, String[])	Sets selectable properties depends on SelectExpandType of this property.
Select(String[])	Sets selectable properties of this property.