HttpParameterBinding Class

 

Describes how a parameter is bound. The binding should be static (based purely on the descriptor) and can be shared across requests.

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

Inheritance Hierarchy

System.Object
  System.Web.Http.Controllers.HttpParameterBinding
    System.Web.Http.ModelBinding.CancellationTokenParameterBinding
    System.Web.Http.ModelBinding.ErrorParameterBinding
    System.Web.Http.ModelBinding.FormatterParameterBinding
    System.Web.Http.ModelBinding.HttpRequestParameterBinding
    System.Web.Http.ModelBinding.ModelBinderParameterBinding

Syntax

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

Constructors

Name Description
System_CAPS_protmethod HttpParameterBinding(HttpParameterDescriptor)

Initializes a new instance of the HttpParameterBinding class.

Properties

Name Description
System_CAPS_pubproperty Descriptor

Gets the HttpParameterDescriptor that was used to initialize this instance.

System_CAPS_pubproperty ErrorMessage

If the binding is invalid, gets an error message that describes the binding error.

System_CAPS_pubproperty IsValid

Gets a value that indicates whether the binding was successful.

System_CAPS_pubproperty WillReadBody

Returns a value indicating whether this HttpParameterBinding instance will read the entity body of the HTTP message.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod ExecuteBindingAsync(ModelMetadataProvider, HttpActionContext, CancellationToken)

Asynchronously executes the binding for the given request.

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod GetValue(HttpActionContext)

Gets the parameter value from argument dictionary of the action context.

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethod SetValue(HttpActionContext, Object)

Sets the result of this parameter binding in the argument dictionary of the action context.

System_CAPS_pubmethod ToString()

(Inherited from Object.)

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