SelectExtensions.ListBox Method
Returns a select element that lets users select one or more items.
Assembly: System.Web.Mvc (in System.Web.Mvc.dll)
| Name | Description | |
|---|---|---|
![]() ![]() | ListBox(HtmlHelper, String) | Returns a multi-select select element using the specified HTML helper and the name of the form field. |
![]() ![]() | ListBox(HtmlHelper, String, IEnumerable<SelectListItem>) | Returns a multi-select select element using the specified HTML helper, the name of the form field, and the specified list items. |
![]() ![]() | ListBox(HtmlHelper, String, IEnumerable<SelectListItem>, IDictionary<String, Object>) | Returns a multi-select select element using the specified HTML helper, the name of the form field, the specified list items, and the specified HMTL attributes. |
![]() ![]() | ListBox(HtmlHelper, String, IEnumerable<SelectListItem>, Object) | Returns a multi-select select element using the specified HTML helper, the name of the form field, and the specified list items. |
The ListBox method renders an element that enables the user to select from a scrolling list of items. Each item in the list is a SelectListItem object.
The difference between calling the ListBox method and using a select element is that the ListBox method is designed to make it easy to bind to view data or model data.
SelectExtensions.ListBox Method (HtmlHelper, String)
Returns a multi-select select element using the specified HTML helper and the name of the form field.
Parameters
- htmlHelper
-
Type:
System.Web.Mvc.HtmlHelper
The HTML helper instance that this method extends.
- name
-
Type:
System.String
The name of the form field to return.
| Exception | Condition |
|---|---|
| ArgumentException | The name parameter is null or empty. |
The ListBox method renders an element that enables the user to select from a scrolling list of items. Each item in the list is a SelectListItem object.
The difference between calling the ListBox method and using a select element is that the ListBox method is designed to make it easy to bind to view data or model data.
SelectExtensions.ListBox Method (HtmlHelper, String, IEnumerable<SelectListItem>)
Returns a multi-select select element using the specified HTML helper, the name of the form field, and the specified list items.
public static MvcHtmlString ListBox( this HtmlHelper htmlHelper, string name, IEnumerable<SelectListItem> selectList )
Parameters
- htmlHelper
-
Type:
System.Web.Mvc.HtmlHelper
The HTML helper instance that this method extends.
- name
-
Type:
System.String
The name of the form field to return.
- selectList
-
Type:
System.Collections.Generic.IEnumerable<SelectListItem>
A collection of SelectListItem objects that are used to populate the drop-down list.
Return Value
Type: System.Web.Mvc.MvcHtmlStringAn HTML select element with an option subelement for each item in the list.
| Exception | Condition |
|---|---|
| ArgumentException | The name parameter is null or empty. |
The ListBox method renders an element that enables the user to select from a scrolling list of items. Each item in the list is a SelectListItem object.
The difference between calling the ListBox method and using a select element is that the ListBox method is designed to make it easy to bind to view data or model data.
SelectExtensions.ListBox Method (HtmlHelper, String, IEnumerable<SelectListItem>, IDictionary<String, Object>)
Returns a multi-select select element using the specified HTML helper, the name of the form field, the specified list items, and the specified HMTL attributes.
public static MvcHtmlString ListBox( this HtmlHelper htmlHelper, string name, IEnumerable<SelectListItem> selectList, IDictionary<string, object> htmlAttributes )
Parameters
- htmlHelper
-
Type:
System.Web.Mvc.HtmlHelper
The HTML helper instance that this method extends.
- name
-
Type:
System.String
The name of the form field to return.
- selectList
-
Type:
System.Collections.Generic.IEnumerable<SelectListItem>
A collection of SelectListItem objects that are used to populate the drop-down list.
- htmlAttributes
-
Type:
System.Collections.Generic.IDictionary<String, Object>
An object that contains the HTML attributes to set for the element.
Return Value
Type: System.Web.Mvc.MvcHtmlStringAn HTML select element with an option subelement for each item in the list..
| Exception | Condition |
|---|---|
| ArgumentException | The name parameter is null or empty. |
The ListBox method renders an element that enables the user to select from a scrolling list of items. Each item in the list is a SelectListItem object.
The difference between calling the ListBox method and using a select element is that the ListBox method is designed to make it easy to bind to view data or model data.
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:
SelectExtensions.ListBox Method (HtmlHelper, String, IEnumerable<SelectListItem>, Object)
Returns a multi-select select element using the specified HTML helper, the name of the form field, and the specified list items.
public static MvcHtmlString ListBox( this HtmlHelper htmlHelper, string name, IEnumerable<SelectListItem> selectList, object htmlAttributes )
Parameters
- htmlHelper
-
Type:
System.Web.Mvc.HtmlHelper
The HTML helper instance that this method extends.
- name
-
Type:
System.String
The name of the form field to return.
- selectList
-
Type:
System.Collections.Generic.IEnumerable<SelectListItem>
A collection of SelectListItem objects that are used to populate the drop-down list.
- htmlAttributes
-
Type:
System.Object
An object that contains the HTML attributes to set for the element.
Return Value
Type: System.Web.Mvc.MvcHtmlStringAn HTML select element with an option subelement for each item in the list..
| Exception | Condition |
|---|---|
| ArgumentException | The name parameter is null or empty. |
The ListBox method renders an element that enables the user to select from a scrolling list of items. Each item in the list is a SelectListItem object.
The difference between calling the ListBox method and using a select element is that the ListBox method is designed to make it easy to bind to view data or model data.
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:

