Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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.

Namespace:  System.Web.Mvc.Html
Assembly:  System.Web.Mvc (in System.Web.Mvc.dll)
static member ListBox : 
        htmlHelper:HtmlHelper * 
        name:string * 
        selectList:IEnumerable<SelectListItem> -> MvcHtmlString

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.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 http://msdn.microsoft.com/en-us/library/bb384936.aspx or http://msdn.microsoft.com/en-us/library/bb383977.aspx.
ExceptionCondition
ArgumentException

The name parameter is a null reference (Nothing in Visual Basic) 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.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.