ODataQueryOptions Class
This defines a composite OData query options that can be used to perform query composition. Currently this only supports $filter, $orderby, $top, $skip, and $inlinecount.
Inheritance Hierarchy
System.Object
System.Web.Http.OData.Query.ODataQueryOptions
System.Web.Http.OData.Query.ODataQueryOptions<TEntity>
Namespace: System.Web.Http.OData.Query
Assembly: System.Web.Http.OData (in System.Web.Http.OData.dll)
Syntax
'Declaration
<ODataQueryParameterBindingAttribute> _
Public Class ODataQueryOptions
'Usage
Dim instance As ODataQueryOptions
[ODataQueryParameterBindingAttribute]
public class ODataQueryOptions
[ODataQueryParameterBindingAttribute]
public ref class ODataQueryOptions
[<ODataQueryParameterBindingAttribute>]
type ODataQueryOptions = class end
public class ODataQueryOptions
The ODataQueryOptions type exposes the following members.
Constructors
Name | Description | |
---|---|---|
ODataQueryOptions | Initializes a new instance of the ODataQueryOptions class. |
Top
Properties
Name | Description | |
---|---|---|
Context | Gets the given ODataQueryContext. | |
Filter | Gets or sets the filter query option. | |
InlineCount | Gets or sets a value that corresponds to allowing the inlinecount query option. | |
OrderBy | Gets or sets a value that corresponds to allowing the orderby query option. | |
RawValues | Gets the raw string of all the OData query options. | |
Request | Gets the request message associated with this instance. | |
SelectExpand | Gets the SelectExpandQueryOption. | |
Skip | Gets the SkipQueryOption. | |
Top | Gets the TopQueryOption. | |
Validator | Gets or sets the query validator. |
Top
Methods
Name | Description | |
---|---|---|
ApplyTo(IQueryable) | Apply the individual query to the given IQueryable in the right order. | |
ApplyTo(IQueryable, ODataQuerySettings) | Apply the individual query to the given IQueryable in the right order. | |
ApplyTo(Object, ODataQuerySettings) | Applies the query to the given entity using the given ODataQuerySettings. | |
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
IsSystemQueryOption | Check if the given query option is an OData system query option. | |
LimitResults<T> | Limits the query results to a maximum number of results. | |
MemberwiseClone | (Inherited from Object.) | |
ToString | (Inherited from Object.) | |
Validate | Validate all OData queries, including skip, top, orderby and filter, based on the given validationSettings. It throws an ODataException if validation failed. |
Top
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.