Class TopQueryOption

Namespace

System.Web.Http.OData.Query

Assembly

System.Web.Http.OData.dll

This defines a $top OData query option for querying.

public class TopQueryOption

Inheritance

object

TopQueryOption

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

TopQueryOption(string, ODataQueryContext)

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

public TopQueryOption(string rawValue, ODataQueryContext context)

Parameters

rawValue string

The raw value for $top query. It can be null or empty.

context ODataQueryContext

The ODataQueryContext which contains the Microsoft.Data.Edm.IEdmModel and some type information

Properties

Context

Gets the given ODataQueryContext.

public ODataQueryContext Context { get; }

Property Value

ODataQueryContext

RawValue

Gets the raw $top value.

public string RawValue { get; }

Property Value

string

Validator

Gets or sets the Top Query Validator.

public TopQueryValidator Validator { get; set; }

Property Value

TopQueryValidator

Value

Gets the value of the $top as a parsed integer.

public int Value { get; }

Property Value

int

Methods

ApplyTo(IQueryable, ODataQuerySettings)

Apply the $top query to the given IQueryable.

public IQueryable ApplyTo(IQueryable query, ODataQuerySettings querySettings)

Parameters

query IQueryable

The original IQueryable.

querySettings ODataQuerySettings

The query settings to use while applying this query option.

Returns

IQueryable

The new IQueryable after the top query has been applied to.

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

Apply the $top query to the given IQueryable.

public IOrderedQueryable<T> ApplyTo<T>(IQueryable<T> query, ODataQuerySettings querySettings)

Parameters

query IQueryable<T>

The original IQueryable.

querySettings ODataQuerySettings

The query settings to use while applying this query option.

Returns

IOrderedQueryable<T>

The new IQueryable after the top query has been applied to.

Type Parameters

T

Validate(ODataValidationSettings)

Validate the top query based on the given validationSettings. It throws an ODataException if validation failed.

public void Validate(ODataValidationSettings validationSettings)

Parameters

validationSettings ODataValidationSettings

The ODataValidationSettings instance which contains all the validation settings.