ODataQueryOptions<TEntity> Class

Article
03/25/2014

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

Top

Methods

	Name	Description
	ApplyTo(IQueryable)	Apply the individual query to the given IQueryable in the right order. (Overrides ODataQueryOptions.ApplyTo(IQueryable).)
	ApplyTo(Object, ODataQuerySettings)	Applies the query to the given entity using the given ODataQuerySettings. (Inherited from ODataQueryOptions.)
	ApplyTo(IQueryable, ODataQuerySettings)	Apply the individual query to the given IQueryable in the right order. (Overrides ODataQueryOptions.ApplyTo(IQueryable, ODataQuerySettings).)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	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. (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.

Share via