PrimitivePropertyConfiguration Class
Definition
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.
Used to configure a primitive property of an entity type or complex type. This configuration functionality is exposed by the model builder Fluent API, see ODataModelBuilder.
public class PrimitivePropertyConfiguration : Microsoft.AspNet.OData.Builder.StructuralPropertyConfigurationtype PrimitivePropertyConfiguration = class
inherit StructuralPropertyConfigurationPublic Class PrimitivePropertyConfiguration
Inherits StructuralPropertyConfiguration- Inheritance
- Derived
Constructors
| PrimitivePropertyConfiguration(PropertyInfo, StructuralTypeConfiguration) |
Initializes a new instance of the PrimitivePropertyConfiguration class. |
Properties
| AddedExplicitly |
Gets or sets a value that is |
| 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) |
| DefaultValueString |
Gets or sets a value string representation of default value. |
| 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 type of this 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) |
| OptionalProperty |
Gets or sets a value indicating whether this property is optional or not. (Inherited from StructuralPropertyConfiguration) |
| Order |
Get or sets order in "order by" expression. (Inherited from PropertyConfiguration) |
| 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. |
| TargetEdmTypeKind |
Gets the target Edm type kind of this property. Call the extension methods to set this property. |
| Unsortable |
Gets or sets whether the property is unsortable. default is false. (Inherited from PropertyConfiguration) |
Methods
| 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) |
| IsConcurrencyToken() |
Configures the property to be used in concurrency checks. For OData this means to be part of the ETag. |
| 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() |
Configures the property to be optional. |
| IsRequired() |
Configures the property to be required. |
| IsSortable() |
Sets the property as sortable. (Inherited from PropertyConfiguration) |
| IsUnsortable() |
Sets the property as unsortable. (Inherited from PropertyConfiguration) |
| 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) |
| 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) |
Extension Methods
| AsDate(PrimitivePropertyConfiguration) |
If this primitive property is DateTime, this method will make the target Edm type kind as Date |
| AsTimeOfDay(PrimitivePropertyConfiguration) |
If this primitive property is TimeSpan, this method will make the target Edm type kind as TimeOfDay |