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.

Namespace:   System.Web.Http.OData.Query
Assembly:  System.Web.Http.OData (in System.Web.Http.OData.dll)

Inheritance Hierarchy

System.Object
  System.Web.Http.OData.Query.ODataQueryOptions
    System.Web.Http.OData.Query.ODataQueryOptions<TEntity>

Syntax

[ODataQueryParameterBindingAttribute]
public class ODataQueryOptions

[ODataQueryParameterBindingAttribute]
public ref class ODataQueryOptions 

[<ODataQueryParameterBindingAttribute>]
type ODataQueryOptions = class end

<ODataQueryParameterBindingAttribute>
Public Class ODataQueryOptions

Constructors

	Name	Description
	ODataQueryOptions(ODataQueryContext, HttpRequestMessage)	Initializes a new instance of the ODataQueryOptions class based on the incoming request and some metadata information from the ODataQueryContext.

Properties

	Name	Description
	Context	Gets the given ODataQueryContext
	Filter	Gets the FilterQueryOption.
	IfMatch	Gets the ETag from the IfMatch header, if any.
	IfNoneMatch	Gets the ETag from the IfNoneMatch header, if any.
	InlineCount	Gets the InlineCountQueryOption.
	OrderBy	Gets the OrderByQueryOption.
	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.

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(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	IsSystemQueryOption(String)	Check if the given query option is an OData system query option.
	LimitResults<T>(IQueryable<T>, Int32, Boolean)	Limits the query results to a maximum number of results.
	MemberwiseClone()	(Inherited from Object.)
	ToString()	(Inherited from Object.)
	Validate(ODataValidationSettings)	Validate all OData queries, including $skip, $top, $orderby and $filter, based on the given validationSettings. It throws an ODataException if validation failed.

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

System.Web.Http.OData.Query Namespace

Return to top