Share via


TopQueryOption Class

This defines a $top OData query option for querying.

Inheritance Hierarchy

System.Object
  System.Web.Http.OData.Query.TopQueryOption

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

Syntax

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

The TopQueryOption type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property Context Gets the given ODataQueryContext .
Public property RawValue Gets the raw $top value.
Public property Validator Gets or sets the Top Query Validator.
Public property Value Gets the value of the $top as a parsed integer.

Top

Methods

  Name Description
Public method ApplyTo(IQueryable, ODataQuerySettings) Apply the $top query to the given IQueryable.
Public method ApplyTo<T>(IQueryable<T>, ODataQuerySettings) Apply the $top 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 top 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