Class HttpParameterDescriptor

Namespace

System.Web.Http.Controllers

Assembly

System.Web.Http.dll

No content here will be updated; please do not add material here.

public abstract class HttpParameterDescriptor

Inheritance

object

HttpParameterDescriptor

Derived

ReflectedHttpParameterDescriptor

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ParameterBindingExtensions.BindAsError(HttpParameterDescriptor, string)

ParameterBindingExtensions.BindWithAttribute(HttpParameterDescriptor, ParameterBindingAttribute)

ParameterBindingExtensions.BindWithFormatter(HttpParameterDescriptor)

ParameterBindingExtensions.BindWithFormatter(HttpParameterDescriptor, IEnumerable<MediaTypeFormatter>)

ParameterBindingExtensions.BindWithFormatter(HttpParameterDescriptor, IEnumerable<MediaTypeFormatter>, IBodyModelValidator)

ParameterBindingExtensions.BindWithFormatter(HttpParameterDescriptor, params MediaTypeFormatter[])

ParameterBindingExtensions.BindWithModelBinding(HttpParameterDescriptor)

ParameterBindingExtensions.BindWithModelBinding(HttpParameterDescriptor, IEnumerable<ValueProviderFactory>)

ParameterBindingExtensions.BindWithModelBinding(HttpParameterDescriptor, IModelBinder)

ParameterBindingExtensions.BindWithModelBinding(HttpParameterDescriptor, IModelBinder, IEnumerable<ValueProviderFactory>)

ParameterBindingExtensions.BindWithModelBinding(HttpParameterDescriptor, params ValueProviderFactory[])

Constructors

HttpParameterDescriptor()

Initializes a new instance of the HttpParameterDescriptor class.

protected HttpParameterDescriptor()

HttpParameterDescriptor(HttpActionDescriptor)

Initializes a new instance of the HttpParameterDescriptor class.

protected HttpParameterDescriptor(HttpActionDescriptor actionDescriptor)

Parameters

actionDescriptor HttpActionDescriptor

The action descriptor.

Properties

ActionDescriptor

Gets or sets the action descriptor.

public HttpActionDescriptor ActionDescriptor { get; set; }

Property Value

HttpActionDescriptor

The action descriptor.

Configuration

Gets or sets the HttpConfiguration for the HttpParameterDescriptor.

public HttpConfiguration Configuration { get; set; }

Property Value

HttpConfiguration

The HttpConfiguration for the HttpParameterDescriptor.

DefaultValue

Gets the default value of the parameter.

public virtual object DefaultValue { get; }

Property Value

object

The default value of the parameter.

IsOptional

Gets a value that indicates whether the parameter is optional.

public virtual bool IsOptional { get; }

Property Value

bool

true if the parameter is optional; otherwise, false..

ParameterBinderAttribute

Gets or sets the parameter binding attribute.

public virtual ParameterBindingAttribute ParameterBinderAttribute { get; set; }

Property Value

ParameterBindingAttribute

The parameter binding attribute.

ParameterName

Gets the name of the parameter.

public abstract string ParameterName { get; }

Property Value

string

The name of the parameter.

ParameterType

Gets the type of the parameter.

public abstract Type ParameterType { get; }

Property Value

Type

The type of the parameter.

Prefix

Gets the prefix of this parameter.

public virtual string Prefix { get; }

Property Value

string

The prefix of this parameter.

Properties

Gets the properties of this parameter.

public ConcurrentDictionary<object, object> Properties { get; }

Property Value

ConcurrentDictionary<object, object>

The properties of this parameter.

Methods

GetCustomAttributes<T>()

Retrieves a collection of the custom attributes from the parameter.

public virtual Collection<T> GetCustomAttributes<T>() where T : class

Returns

Collection<T>

A collection of the custom attributes from the parameter.

Type Parameters

T

The type of the custom attributes.