Share via


OrderByQueryOption Class

This defines a $orderby OData query option for querying.

Inheritance Hierarchy

System.Object
  System.Web.Http.OData.Query.OrderByQueryOption

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

Syntax

'Declaration
Public Class OrderByQueryOption
'Usage
Dim instance As OrderByQueryOption
public class OrderByQueryOption
public ref class OrderByQueryOption
type OrderByQueryOption =  class end
public class OrderByQueryOption

The OrderByQueryOption type exposes the following members.

Constructors

  Name Description
Public method OrderByQueryOption Initialize a new instance of OrderByQueryOption based on the raw $orderby value and an EdmModel from ODataQueryContext .

Top

Properties

  Name Description
Public property Context Gets the given ODataQueryContext.
Public property OrderByClause Gets the parsed clause for this query option.
Public property OrderByNodes Gets the mutable list of OrderByPropertyNode instances for this query option.
Public property RawValue Gets the raw $orderby value.
Public property Validator Gets or sets the OrderBy Query validator.

Top

Methods

  Name Description
Public method ApplyTo(IQueryable) Apply the $orderby query to the given IQueryable.
Public method ApplyTo(IQueryable, ODataQuerySettings) Apply the $orderby query to the given IQueryable.
Public method ApplyTo<T>(IQueryable<T>) Apply the $orderby query to the given IQueryable.
Public method ApplyTo<T>(IQueryable<T>, ODataQuerySettings) Apply the $orderby query to the given IQueryable.
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 the orderby query based on the given validationSettings . It throws an ODataException if validation failed.

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