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.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function ListBox ( _
    htmlHelper As HtmlHelper, _
    name As String, _
    selectList As IEnumerable(Of SelectListItem), _
    htmlAttributes As Object _
) As MvcHtmlString
'Usage
Dim htmlHelper As HtmlHelper
Dim name As String
Dim selectList As IEnumerable(Of SelectListItem)
Dim htmlAttributes As Object
Dim returnValue As MvcHtmlString

returnValue = htmlHelper.ListBox(name, _
    selectList, htmlAttributes)
public static MvcHtmlString ListBox(
    this HtmlHelper htmlHelper,
    string name,
    IEnumerable<SelectListItem> selectList,
    Object htmlAttributes
)
[ExtensionAttribute]
public:
static MvcHtmlString^ ListBox(
    HtmlHelper^ htmlHelper, 
    String^ name, 
    IEnumerable<SelectListItem^>^ selectList, 
    Object^ htmlAttributes
)
public static function ListBox(
    htmlHelper : HtmlHelper, 
    name : String, 
    selectList : IEnumerable<SelectListItem>, 
    htmlAttributes : Object
) : MvcHtmlString

Parameters

  • htmlAttributes
    Type: System.Object
    An object that contains the HTML attributes to set for the element.

Return Value

Type: System.Web.Mvc.MvcHtmlString
An HTML select element with an option subelement for each item in the list..

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type HtmlHelper. When you use instance method syntax to call this method, omit the first parameter. For more information, see b8020aae-374d-46a9-bcb7-8cc2390b93b6 or 175ce3ff-9bbf-4e64-8421-faeb81a0bb51.

Exceptions

Exception Condition
ArgumentException

The name parameter is nulla null reference (Nothing in Visual Basic) or empty.

Remarks

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:

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

See Also

Reference

SelectExtensions Class

ListBox Overload

System.Web.Mvc.Html Namespace