Export (0) Print
Expand All

QueryableAttribute Class

Enables a controller action to support OData query parameters.

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


[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Method, Inherited = true, 
	AllowMultiple = false)]
public class QueryableAttribute : ActionFilterAttribute

The QueryableAttribute type exposes the following members.

  NameDescription
Public methodQueryableAttributeInitializes a new instance of the QueryableAttribute class.
Top

  NameDescription
Public propertyAllowMultipleGets a value that indicates whether multiple filters are allowed. (Inherited from FilterAttribute.)
Public propertyResultLimitThe maximum number of results that should be returned from this query regardless of query-specified limits.
Protected propertyStructuredQueryBuilder The IStructuredQueryBuilder to use. Derived classes can use this to have a per-attribute query builder instead of the one on HttpConfiguration
Public propertyTypeId (Inherited from Attribute.)
Top

  NameDescription
Protected methodApplyResultLimitApplies the result limit to the query results.
Public methodEquals (Inherited from Attribute.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Attribute.)
Public methodGetType (Inherited from Object.)
Public methodIsDefaultAttribute (Inherited from Attribute.)
Public methodMatch (Inherited from Attribute.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodOnActionExecutedCalled by the Web API framework after the action method executes. (Overrides ActionFilterAttribute.OnActionExecuted(HttpActionExecutedContext).)
Public methodOnActionExecutingCalled by the Web API framework before the action method executes. (Overrides ActionFilterAttribute.OnActionExecuting(HttpActionContext).)
Public methodToString (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNames (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfo (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCount (Inherited from Attribute.)
Explicit interface implemetationPrivate methodIActionFilter.ExecuteActionFilterAsyncExecutes the filter action asynchronously. (Inherited from ActionFilterAttribute.)
Explicit interface implemetationPrivate method_Attribute.Invoke (Inherited from Attribute.)
Top

If a Web API controller action returns an IQueryable, you can mark the action method with QueryableAttribute to support OData query parameters on the request URI.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2015 Microsoft