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)

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

[ODataQueryParameterBindingAttribute]
public ref class ODataQueryOptions 

NameDescription
System_CAPS_pubmethodODataQueryOptions(ODataQueryContext^, HttpRequestMessage^)

Initializes a new instance of the ODataQueryOptions class based on the incoming request and some metadata information from the ODataQueryContext.

NameDescription
System_CAPS_pubpropertyContext

Gets the given ODataQueryContext

System_CAPS_pubpropertyFilter

Gets the FilterQueryOption.

System_CAPS_pubpropertyIfMatch

Gets the ETag from the IfMatch header, if any.

System_CAPS_pubpropertyIfNoneMatch

Gets the ETag from the IfNoneMatch header, if any.

System_CAPS_pubpropertyInlineCount
System_CAPS_pubpropertyOrderBy

Gets the OrderByQueryOption.

System_CAPS_pubpropertyRawValues

Gets the raw string of all the OData query options

System_CAPS_pubpropertyRequest

Gets the request message associated with this instance.

System_CAPS_pubpropertySelectExpand
System_CAPS_pubpropertySkip

Gets the SkipQueryOption.

System_CAPS_pubpropertyTop

Gets the TopQueryOption.

System_CAPS_pubpropertyValidator

Gets or sets the query validator.

NameDescription
System_CAPS_pubmethodApplyTo(IQueryable^)

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

System_CAPS_pubmethodApplyTo(IQueryable^, ODataQuerySettings^)

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

System_CAPS_pubmethodApplyTo(Object^, ODataQuerySettings^)

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

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticIsSystemQueryOption(String^)

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

System_CAPS_pubmethodSystem_CAPS_staticLimitResults<T>(IQueryable<T>^, Int32, Boolean)

Limits the query results to a maximum number of results.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodValidate(ODataValidationSettings^)

Validate all OData queries, including $skip, $top, $orderby and $filter, based on the given validationSettings. It throws an ODataException if validation failed.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: