Share via


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
System_CAPS_pubmethod 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
System_CAPS_pubproperty Context

Gets the given ODataQueryContext

System_CAPS_pubproperty Filter

Gets the FilterQueryOption.

System_CAPS_pubproperty IfMatch

Gets the ETag from the IfMatch header, if any.

System_CAPS_pubproperty IfNoneMatch

Gets the ETag from the IfNoneMatch header, if any.

System_CAPS_pubproperty InlineCount

Gets the InlineCountQueryOption.

System_CAPS_pubproperty OrderBy

Gets the OrderByQueryOption.

System_CAPS_pubproperty RawValues

Gets the raw string of all the OData query options

System_CAPS_pubproperty Request

Gets the request message associated with this instance.

System_CAPS_pubproperty SelectExpand

Gets the SelectExpandQueryOption.

System_CAPS_pubproperty Skip

Gets the SkipQueryOption.

System_CAPS_pubproperty Top

Gets the TopQueryOption.

System_CAPS_pubproperty Validator

Gets or sets the query validator.

Methods

Name Description
System_CAPS_pubmethod ApplyTo(IQueryable)

Apply the individual query to the given IQueryable in the right order.

System_CAPS_pubmethod ApplyTo(IQueryable, ODataQuerySettings)

Apply the individual query to the given IQueryable in the right order.

System_CAPS_pubmethod ApplyTo(Object, ODataQuerySettings)

Applies the query to the given entity using the given ODataQuerySettings.

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_static IsSystemQueryOption(String)

Check if the given query option is an OData system query option.

System_CAPS_pubmethodSystem_CAPS_static LimitResults<T>(IQueryable<T>, Int32, Boolean)

Limits the query results to a maximum number of results.

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

System_CAPS_pubmethod 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