Share via


HttpParameterDescriptor Class

Inheritance Hierarchy

System.Object
  System.Web.Http.Controllers.HttpParameterDescriptor
    System.Web.Http.Controllers.ReflectedHttpParameterDescriptor

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

Syntax

'Declaration
Public MustInherit Class HttpParameterDescriptor
'Usage
Dim instance As HttpParameterDescriptor
public abstract class HttpParameterDescriptor
public ref class HttpParameterDescriptor abstract
[<AbstractClassAttribute>]
type HttpParameterDescriptor =  class end
public abstract class HttpParameterDescriptor

The HttpParameterDescriptor type exposes the following members.

Constructors

  Name Description
Protected method HttpParameterDescriptor() Initializes a new instance of the HttpParameterDescriptor class.
Protected method HttpParameterDescriptor(HttpActionDescriptor) Initializes a new instance of the HttpParameterDescriptor class.

Top

Properties

  Name Description
Public property ActionDescriptor Gets or sets the action descriptor.
Public property Configuration Gets or sets the HttpConfiguration for the HttpParameterDescriptor.
Public property DefaultValue Gets the default value of the parameter.
Public property IsOptional Gets a value that indicates whether the parameter is optional.
Public property ParameterBinderAttribute Gets or sets the parameter binding attribute.
Public property ParameterName Gets the name of the parameter.
Public property ParameterType Gets the type of the parameter.
Public property Prefix Gets the prefix of this parameter.
Public property Properties Gets the properties of this parameter.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetCustomAttributes<T> Retrieves a collection of the custom attributes from the parameter.
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Extension Methods

  Name Description
Public Extension Method BindAsError Binds parameter that results as an error. (Defined by ParameterBindingExtensions.)
Public Extension Method BindWithAttribute Bind the parameter as if it had the given attribute on the declaration. (Defined by ParameterBindingExtensions.)
Public Extension Method BindWithFormatter() Overloaded. Binds parameter by parsing the HTTP body content. (Defined by ParameterBindingExtensions.)
Public Extension Method BindWithFormatter(MediaTypeFormatter[]) Overloaded. Binds parameter by parsing the HTTP body content. (Defined by ParameterBindingExtensions.)
Public Extension Method BindWithFormatter(IEnumerable<MediaTypeFormatter>) Overloaded. Binds parameter by parsing the HTTP body content. (Defined by ParameterBindingExtensions.)
Public Extension Method BindWithFormatter(IEnumerable<MediaTypeFormatter>, IBodyModelValidator) Overloaded. Binds parameter by parsing the HTTP body content. (Defined by ParameterBindingExtensions.)
Public Extension Method BindWithModelBinding() Overloaded. Binds parameter by parsing the query string. (Defined by ParameterBindingExtensions.)
Public Extension Method BindWithModelBinding(IModelBinder) Overloaded. Binds parameter by parsing the query string. (Defined by ParameterBindingExtensions.)
Public Extension Method BindWithModelBinding(ValueProviderFactory[]) Overloaded. Binds parameter by parsing the query string. (Defined by ParameterBindingExtensions.)
Public Extension Method BindWithModelBinding(IEnumerable<ValueProviderFactory>) Overloaded. Binds parameter by parsing the query string. (Defined by ParameterBindingExtensions.)
Public Extension Method BindWithModelBinding(IModelBinder, IEnumerable<ValueProviderFactory>) Overloaded. Binds parameter by parsing the query string. (Defined by ParameterBindingExtensions.)

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.Controllers Namespace