Export (0) Print
Expand All

SelectExtensions.ListBox Method (HtmlHelper, String)

Returns a multi-select select element using the specified HTML helper and the name of the form field.

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

'Declaration
<ExtensionAttribute> _
Public Shared Function ListBox ( _
	htmlHelper As HtmlHelper, _
	name As String _
) As MvcHtmlString
'Usage
Dim htmlHelper As HtmlHelper 
Dim name As String 
Dim returnValue As MvcHtmlString 

returnValue = htmlHelper.ListBox(name)

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.

Return Value

Type: System.Web.Mvc.MvcHtmlString
An HTML select element.

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 https://msdn.microsoft.com/en-us/library/bb384936(v=vs.108).aspx or https://msdn.microsoft.com/en-us/library/bb383977(v=vs.108).aspx.

ExceptionCondition
ArgumentException

The name parameter is Nothing 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.

Show:
© 2015 Microsoft