HttpParameterDescriptor Class

 

Represents the HTTP parameter descriptor.

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

Inheritance Hierarchy

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

Syntax

public abstract class HttpParameterDescriptor
public ref class HttpParameterDescriptor abstract 
[<AbstractClass>]
type HttpParameterDescriptor = class end
Public MustInherit Class HttpParameterDescriptor

Constructors

Name Description
System_CAPS_protmethod HttpParameterDescriptor()

Initializes a new instance of the HttpParameterDescriptor class.

System_CAPS_protmethod HttpParameterDescriptor(HttpActionDescriptor)

Initializes a new instance of the HttpParameterDescriptor class.

Properties

Name Description
System_CAPS_pubproperty ActionDescriptor

Gets or sets the action descriptor.

System_CAPS_pubproperty Configuration

Gets or sets the HttpConfiguration for the HttpParameterDescriptor.

System_CAPS_pubproperty DefaultValue

Gets the default value of the parameter.

System_CAPS_pubproperty IsOptional

Gets a value that indicates whether the parameter is optional.

System_CAPS_pubproperty ParameterBinderAttribute

Gets or sets the parameter binding attribute.

System_CAPS_pubproperty ParameterName

Gets the name of the parameter.

System_CAPS_pubproperty ParameterType

Gets the type of the parameter.

System_CAPS_pubproperty Prefix

Gets the prefix of this parameter.

System_CAPS_pubproperty Properties

Gets the properties of this parameter.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetCustomAttributes<T>()

Retrieves a collection of the custom attributes from the parameter.

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Extension Methods

Name Description
System_CAPS_pubmethod BindAsError(String)

Binds parameter that results as an error. (Defined by ParameterBindingExtensions.)

System_CAPS_pubmethod BindWithAttribute(ParameterBindingAttribute)

Bind the parameter as if it had the given attribute on the declaration.(Defined by ParameterBindingExtensions.)

System_CAPS_pubmethod BindWithFormatter()

Overloaded. Binds parameter by parsing the HTTP body content.(Defined by ParameterBindingExtensions.)

System_CAPS_pubmethod BindWithFormatter(IEnumerable<MediaTypeFormatter>)

Overloaded. Binds parameter by parsing the HTTP body content.(Defined by ParameterBindingExtensions.)

System_CAPS_pubmethod BindWithFormatter(IEnumerable<MediaTypeFormatter>, IBodyModelValidator)

Overloaded. Binds parameter by parsing the HTTP body content.(Defined by ParameterBindingExtensions.)

System_CAPS_pubmethod BindWithFormatter(MediaTypeFormatter[])

Overloaded. Binds parameter by parsing the HTTP body content.(Defined by ParameterBindingExtensions.)

System_CAPS_pubmethod BindWithModelBinding()

Overloaded. Binds parameter by parsing the query string.(Defined by ParameterBindingExtensions.)

System_CAPS_pubmethod BindWithModelBinding(IEnumerable<ValueProviderFactory>)

Overloaded. Binds parameter by parsing the query string.(Defined by ParameterBindingExtensions.)

System_CAPS_pubmethod BindWithModelBinding(IModelBinder)

Overloaded. Binds parameter by parsing the query string.(Defined by ParameterBindingExtensions.)

System_CAPS_pubmethod BindWithModelBinding(IModelBinder, IEnumerable<ValueProviderFactory>)

Overloaded. Binds parameter by parsing the query string.(Defined by ParameterBindingExtensions.)

System_CAPS_pubmethod BindWithModelBinding(ValueProviderFactory[])

Overloaded. Binds parameter by parsing the query string.(Defined by ParameterBindingExtensions.)

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

System.Web.Http.Controllers Namespace

Return to top