OrderByQueryOption Class

Reference

Definition

Namespace:: Microsoft.AspNet.OData.Query

Assembly:: Microsoft.AspNet.OData.dll

Assembly:: Microsoft.AspNetCore.OData.dll

Package:: Microsoft.AspNet.OData v7.5.8

Package:: Microsoft.AspNetCore.OData v7.5.8

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This defines a $orderby OData query option for querying.

public class OrderByQueryOption

type OrderByQueryOption = class

Public Class OrderByQueryOption

Inheritance: Object
OrderByQueryOption

Constructors

OrderByQueryOption(String, ODataQueryContext, ODataQueryOptionParser)

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

Properties

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

Methods

ApplyTo(IQueryable)	Apply the $orderby query to the given IQueryable.
ApplyTo(IQueryable, ODataQuerySettings)	Apply the $orderby query to the given IQueryable.
ApplyTo<T>(IQueryable<T>)	Apply the $orderby query to the given IQueryable.
ApplyTo<T>(IQueryable<T>, ODataQuerySettings)	Apply the $orderby query to the given IQueryable.
Validate(ODataValidationSettings)	Validate the orderby query based on the given `validationSettings`. It throws an ODataException if validation failed.

Applies to