Share via


ODataQueryOptions<TEntity> Class

This defines a composite OData query option that can be used to perform query composition. Currently this only supports $filter, $orderby, $top, $skip.

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(Of TEntity) _
    Inherits ODataQueryOptions
'Usage
Dim instance As ODataQueryOptions(Of TEntity)
[ODataQueryParameterBindingAttribute]
public class ODataQueryOptions<TEntity> : ODataQueryOptions
[ODataQueryParameterBindingAttribute]
generic<typename TEntity>
public ref class ODataQueryOptions : public ODataQueryOptions
[<ODataQueryParameterBindingAttribute>]
type ODataQueryOptions<'TEntity> =  
    class 
        inherit ODataQueryOptions 
    end
JScript does not support generic types and methods.

Type Parameters

  • TEntity

The ODataQueryOptions<TEntity> type exposes the following members.

Constructors

  Name Description
Public method ODataQueryOptions<TEntity> Initializes a new instance of the ODataQueryOptions class based on the incoming request and some metadata information from the ODataQueryContext .

Top

Properties

  Name Description
Public property Context Gets the given ODataQueryContext. (Inherited from ODataQueryOptions.)
Public property Filter Gets or sets the filter query option. (Inherited from ODataQueryOptions.)
Public property InlineCount Gets or sets a value that corresponds to allowing the inlinecount query option. (Inherited from ODataQueryOptions.)
Public property OrderBy Gets or sets a value that corresponds to allowing the orderby query option. (Inherited from ODataQueryOptions.)
Public property RawValues Gets the raw string of all the OData query options. (Inherited from ODataQueryOptions.)
Public property Request Gets the request message associated with this instance. (Inherited from ODataQueryOptions.)
Public property SelectExpand Gets the SelectExpandQueryOption. (Inherited from ODataQueryOptions.)
Public property Skip Gets the SkipQueryOption. (Inherited from ODataQueryOptions.)
Public property Top Gets the TopQueryOption. (Inherited from ODataQueryOptions.)
Public property Validator Gets or sets the query validator. (Inherited from ODataQueryOptions.)

Top

Methods

  Name Description
Public method ApplyTo(IQueryable) Apply the individual query to the given IQueryable in the right order. (Overrides ODataQueryOptions.ApplyTo(IQueryable).)
Public method ApplyTo(Object, ODataQuerySettings) Applies the query to the given entity using the given ODataQuerySettings. (Inherited from ODataQueryOptions.)
Public method ApplyTo(IQueryable, ODataQuerySettings) Apply the individual query to the given IQueryable in the right order. (Overrides ODataQueryOptions.ApplyTo(IQueryable, ODataQuerySettings).)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)
Public method Validate Validate all OData queries, including skip, top, orderby and filter, based on the given validationSettings. It throws an ODataException if validation failed. (Inherited from ODataQueryOptions.)

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.

See Also

Reference

System.Web.Http.OData.Query Namespace