IHtmlHelper.DropDownList Method

Definition

Namespace:

Microsoft.AspNetCore.Mvc.Rendering

Assembly:

Microsoft.AspNetCore.Mvc.ViewFeatures.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Source:

IHtmlHelper.cs

Returns a single-selection HTML <select> element for the expression. Adds <option> elements based on optionLabel and selectList. Adds a "selected" attribute to an <option> if its Value (if non-null) or Text matches the first non-null value found in: the ModelState entry with full name, the ViewData entry with full name (unless used instead of selectList), or the expression evaluated against Model. See Name(String) for more information about a "full name".

public:
 Microsoft::AspNetCore::Html::IHtmlContent ^ DropDownList(System::String ^ expression, System::Collections::Generic::IEnumerable<Microsoft::AspNetCore::Mvc::Rendering::SelectListItem ^> ^ selectList, System::String ^ optionLabel, System::Object ^ htmlAttributes);

public Microsoft.AspNetCore.Html.IHtmlContent DropDownList (string expression, System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Mvc.Rendering.SelectListItem> selectList, string optionLabel, object htmlAttributes);

abstract member DropDownList : string * seq<Microsoft.AspNetCore.Mvc.Rendering.SelectListItem> * string * obj -> Microsoft.AspNetCore.Html.IHtmlContent

Public Function DropDownList (expression As String, selectList As IEnumerable(Of SelectListItem), optionLabel As String, htmlAttributes As Object) As IHtmlContent

Parameters

expression

String

Expression name, relative to the current model.

selectList

IEnumerable<SelectListItem>

A collection of SelectListItem objects used to populate the <select> element with <optgroup> and <option> elements. If null, uses the ViewData entry with full name and that entry must be a collection of SelectListItem objects.

optionLabel

String

The text for a default empty item. Does not include such an item if argument is null.

htmlAttributes

Object

An Object that contains the HTML attributes for the <select> element. Alternatively, an IDictionary<TKey,TValue> instance containing the HTML attributes.

Returns

IHtmlContent

A new IHtmlContent containing the <select> element.

Remarks

Combines HtmlFieldPrefix and expression to set <select> element's "name" attribute. Sanitizes expression to set element's "id" attribute.