Share via


OrderByQueryOption Class

 

This defines a $orderby OData query option for querying.

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.OrderByQueryOption

Syntax

public class OrderByQueryOption
public ref class OrderByQueryOption 
type OrderByQueryOption = class end
Public Class OrderByQueryOption

Constructors

Name Description
System_CAPS_pubmethod OrderByQueryOption(String, ODataQueryContext)

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

Properties

Name Description
System_CAPS_pubproperty Context

Gets the given ODataQueryContext.

System_CAPS_pubproperty OrderByClause

Gets the parsed OrderByClause for this query option.

System_CAPS_pubproperty OrderByNodes

Gets the mutable list of OrderByPropertyNode instances for this query option.

System_CAPS_pubproperty RawValue

Gets the raw $orderby value.

System_CAPS_pubproperty Validator

Gets or sets the OrderBy Query Validator.

Methods

Name Description
System_CAPS_pubmethod ApplyTo(IQueryable)

Apply the $orderby query to the given IQueryable.

System_CAPS_pubmethod ApplyTo(IQueryable, ODataQuerySettings)

Apply the $orderby query to the given IQueryable.

System_CAPS_pubmethod ApplyTo<T>(IQueryable<T>)

Apply the $orderby query to the given IQueryable.

System_CAPS_pubmethod ApplyTo<T>(IQueryable<T>, ODataQuerySettings)

Apply the $orderby query to the given IQueryable.

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_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

System_CAPS_pubmethod Validate(ODataValidationSettings)

Validate the orderby query 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