SelectExtensions.DropDownListFor<TModel, TProperty> Method (HtmlHelper<TModel>, Expression<Func<TModel, TProperty>>, IEnumerable<SelectListItem>, String, IDictionary<String, Object>)

Article
2011-02-21

Returns an HTML select element for each property in the object that is represented by the specified expression using the specified list items, option label, and HTML attributes.

Namespace: System.Web.Mvc.Html
Assembly: System.Web.Mvc (in System.Web.Mvc.dll)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function DropDownListFor(Of TModel, TProperty) ( _
    htmlHelper As HtmlHelper(Of TModel), _
    expression As Expression(Of Func(Of TModel, TProperty)), _
    selectList As IEnumerable(Of SelectListItem), _
    optionLabel As String, _
    htmlAttributes As IDictionary(Of String, Object) _
) As MvcHtmlString

public static MvcHtmlString DropDownListFor<TModel, TProperty>(
    this HtmlHelper<TModel> htmlHelper,
    Expression<Func<TModel, TProperty>> expression,
    IEnumerable<SelectListItem> selectList,
    string optionLabel,
    IDictionary<string, Object> htmlAttributes
)

[ExtensionAttribute]
public:
generic<typename TModel, typename TProperty>
static MvcHtmlString^ DropDownListFor(
    HtmlHelper<TModel>^ htmlHelper, 
    Expression<Func<TModel, TProperty>^>^ expression, 
    IEnumerable<SelectListItem^>^ selectList, 
    String^ optionLabel, 
    IDictionary<String^, Object^>^ htmlAttributes
)

Type Parameters

TModel
The type of the model.

TProperty
The type of the value.

Parameters

htmlHelper
Type: System.Web.Mvc.HtmlHelper<TModel>
The HTML helper instance that this method extends.

expression
Type: System.Linq.Expressions.Expression<Func<TModel, TProperty>>
An expression that identifies the object that contains the properties to render.

selectList
Type: System.Collections.Generic.IEnumerable<SelectListItem>
A collection of SelectListItem objects that are used to populate the drop-down list.

optionLabel
Type: System.String
The text for a default empty item. This parameter can be null reference (Nothing in Visual Basic).

htmlAttributes
Type: System.Collections.Generic.IDictionary<String, Object>
A dictionary that contains the HTML attributes to set for the element.

Return Value

Type: System.Web.Mvc.MvcHtmlString
An HTML select element for each property in the object that is represented by the expression.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type HtmlHelper<TModel>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	The expression parameter is null reference (Nothing in Visual Basic).

Remarks

The htmlAttributes parameter consists of an object that contains name/value pairs. The attributes that are specified in the name/value pairs depend on the HTML element that is being rendered. For example, for a select element, you might provide the following anonymous object:

new { id = "select1", size="8" }

New With { .id = "select1",.size="8" }

Share via