SelectExtensions.DropDownList Method

 

Returns a select element that lets users select one item.

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

Overload List

Name Description
System_CAPS_pubmethodSystem_CAPS_static DropDownList(HtmlHelper, String)

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

System_CAPS_pubmethodSystem_CAPS_static DropDownList(HtmlHelper, String, IEnumerable<SelectListItem>)

Returns a single-selection select element using the specified HTML helper, the name of the form field, and the specified list items.

System_CAPS_pubmethodSystem_CAPS_static DropDownList(HtmlHelper, String, IEnumerable<SelectListItem>, IDictionary<String, Object>)

Returns a single-selection select element using the specified HTML helper, the name of the form field, the specified list items, and the specified HTML attributes.

System_CAPS_pubmethodSystem_CAPS_static DropDownList(HtmlHelper, String, IEnumerable<SelectListItem>, Object)

Returns a single-selection select element using the specified HTML helper, the name of the form field, the specified list items, and the specified HTML attributes.

System_CAPS_pubmethodSystem_CAPS_static DropDownList(HtmlHelper, String, IEnumerable<SelectListItem>, String)

Returns a single-selection select element using the specified HTML helper, the name of the form field, the specified list items, and an option label.

System_CAPS_pubmethodSystem_CAPS_static DropDownList(HtmlHelper, String, IEnumerable<SelectListItem>, String, IDictionary<String, Object>)

Returns a single-selection select element using the specified HTML helper, the name of the form field, the specified list items, an option label, and the specified HTML attributes.

System_CAPS_pubmethodSystem_CAPS_static DropDownList(HtmlHelper, String, IEnumerable<SelectListItem>, String, Object)

Returns a single-selection select element using the specified HTML helper, the name of the form field, the specified list items, an option label, and the specified HTML attributes.

System_CAPS_pubmethodSystem_CAPS_static DropDownList(HtmlHelper, String, String)

Returns a single-selection select element using the specified HTML helper, the name of the form field, and an option label.

Remarks

The DropDownList method renders an element that enables the user to select one item from a drop-down list. Each item in the list is a SelectListItem object.

The difference between calling the DropDownList method and using a select element is that the DropDownList method is designed to make it easy to bind to view data or model data.

See Also

SelectExtensions Class
System.Web.Mvc.Html Namespace

Return to top

SelectExtensions.DropDownList Method (HtmlHelper, String)

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

Syntax

public static MvcHtmlString DropDownList(
    this HtmlHelper htmlHelper,
    string name
)
public:
[ExtensionAttribute]
static MvcHtmlString^ DropDownList(
    HtmlHelper^ htmlHelper,
    String^ name
)
static member DropDownList : 
        htmlHelper:HtmlHelper *
        name:string -> MvcHtmlString
<ExtensionAttribute>
Public Shared Function DropDownList (
    htmlHelper As HtmlHelper,
    name As String
) As MvcHtmlString

Parameters

Return Value

Type: System.Web.Mvc.MvcHtmlString

An HTML select element.

Exceptions

Exception Condition
ArgumentException

The name parameter is null or empty.

Remarks

The DropDownList method renders an element that enables the user to select one item from a drop-down list. Each item in the list is a SelectListItem object.

The difference between calling the DropDownList method and using a select element is that the DropDownList method is designed to make it easy to bind to view data or model data.

Return to top

SelectExtensions.DropDownList Method (HtmlHelper, String, IEnumerable<SelectListItem>)

Returns a single-selection select element using the specified HTML helper, the name of the form field, and the specified list items.

Syntax

public static MvcHtmlString DropDownList(
    this HtmlHelper htmlHelper,
    string name,
    IEnumerable<SelectListItem> selectList
)
public:
[ExtensionAttribute]
static MvcHtmlString^ DropDownList(
    HtmlHelper^ htmlHelper,
    String^ name,
    IEnumerable<SelectListItem^>^ selectList
)
static member DropDownList : 
        htmlHelper:HtmlHelper *
        name:string *
        selectList:IEnumerable<SelectListItem> -> MvcHtmlString
<ExtensionAttribute>
Public Shared Function DropDownList (
    htmlHelper As HtmlHelper,
    name As String,
    selectList As IEnumerable(Of SelectListItem)
) As MvcHtmlString

Parameters

Return Value

Type: System.Web.Mvc.MvcHtmlString

An HTML select element with an option subelement for each item in the list.

Exceptions

Exception Condition
ArgumentException

The name parameter is null or empty.

Remarks

The DropDownList method renders an element that enables the user to select one item from a drop-down list. Each item in the list is a SelectListItem object.

The difference between calling the DropDownList method and using a select element is that the DropDownList method is designed to make it easy to bind to view data or model data.

Return to top

SelectExtensions.DropDownList Method (HtmlHelper, String, IEnumerable<SelectListItem>, IDictionary<String, Object>)

Returns a single-selection select element using the specified HTML helper, the name of the form field, the specified list items, and the specified HTML attributes.

Syntax

public static MvcHtmlString DropDownList(
    this HtmlHelper htmlHelper,
    string name,
    IEnumerable<SelectListItem> selectList,
    IDictionary<string, object> htmlAttributes
)
public:
[ExtensionAttribute]
static MvcHtmlString^ DropDownList(
    HtmlHelper^ htmlHelper,
    String^ name,
    IEnumerable<SelectListItem^>^ selectList,
    IDictionary<String^, Object^>^ htmlAttributes
)
static member DropDownList : 
        htmlHelper:HtmlHelper *
        name:string *
        selectList:IEnumerable<SelectListItem> *
        htmlAttributes:IDictionary<string, Object> -> MvcHtmlString
<ExtensionAttribute>
Public Shared Function DropDownList (
    htmlHelper As HtmlHelper,
    name As String,
    selectList As IEnumerable(Of SelectListItem),
    htmlAttributes As IDictionary(Of String, Object)
) As MvcHtmlString

Parameters

Return Value

Type: System.Web.Mvc.MvcHtmlString

An HTML select element with an option subelement for each item in the list.

Exceptions

Exception Condition
ArgumentException

The name parameter is null or empty.

Remarks

The DropDownList method renders an element that enables the user to select one item from a drop-down list. Each item in the list is a SelectListItem object.

The difference between calling the DropDownList method and using a select element is that the DropDownList 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" }

Return to top

SelectExtensions.DropDownList Method (HtmlHelper, String, IEnumerable<SelectListItem>, Object)

Returns a single-selection select element using the specified HTML helper, the name of the form field, the specified list items, and the specified HTML attributes.

Syntax

public static MvcHtmlString DropDownList(
    this HtmlHelper htmlHelper,
    string name,
    IEnumerable<SelectListItem> selectList,
    object htmlAttributes
)
public:
[ExtensionAttribute]
static MvcHtmlString^ DropDownList(
    HtmlHelper^ htmlHelper,
    String^ name,
    IEnumerable<SelectListItem^>^ selectList,
    Object^ htmlAttributes
)
static member DropDownList : 
        htmlHelper:HtmlHelper *
        name:string *
        selectList:IEnumerable<SelectListItem> *
        htmlAttributes:Object -> MvcHtmlString
<ExtensionAttribute>
Public Shared Function DropDownList (
    htmlHelper As HtmlHelper,
    name As String,
    selectList As IEnumerable(Of SelectListItem),
    htmlAttributes As Object
) As 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.

Exceptions

Exception Condition
ArgumentException

The name parameter is null or empty.

Remarks

The DropDownList method renders an element that enables the user to select one item from a drop-down list. Each item in the list is a SelectListItem object.

The difference between calling the DropDownList method and using a select element is that the DropDownList 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" }

Return to top

SelectExtensions.DropDownList Method (HtmlHelper, String, IEnumerable<SelectListItem>, String)

Returns a single-selection select element using the specified HTML helper, the name of the form field, the specified list items, and an option label.

Syntax

public static MvcHtmlString DropDownList(
    this HtmlHelper htmlHelper,
    string name,
    IEnumerable<SelectListItem> selectList,
    string optionLabel
)
public:
[ExtensionAttribute]
static MvcHtmlString^ DropDownList(
    HtmlHelper^ htmlHelper,
    String^ name,
    IEnumerable<SelectListItem^>^ selectList,
    String^ optionLabel
)
static member DropDownList : 
        htmlHelper:HtmlHelper *
        name:string *
        selectList:IEnumerable<SelectListItem> *
        optionLabel:string -> MvcHtmlString
<ExtensionAttribute>
Public Shared Function DropDownList (
    htmlHelper As HtmlHelper,
    name As String,
    selectList As IEnumerable(Of SelectListItem),
    optionLabel As String
) As MvcHtmlString

Parameters

  • optionLabel
    Type: System.String

    The text for a default empty item. This parameter can be null.

Return Value

Type: System.Web.Mvc.MvcHtmlString

An HTML select element with an option subelement for each item in the list.

Exceptions

Exception Condition
ArgumentException

The name parameter is null or empty.

Remarks

The DropDownList method renders an element that enables the user to select one item from a drop-down list. Each item in the list is a SelectListItem object.

The difference between calling the DropDownList method and using a select element is that the DropDownList method is designed to make it easy to bind to view data or model data.

Return to top

SelectExtensions.DropDownList Method (HtmlHelper, String, IEnumerable<SelectListItem>, String, IDictionary<String, Object>)

Returns a single-selection select element using the specified HTML helper, the name of the form field, the specified list items, an option label, and the specified HTML attributes.

Syntax

public static MvcHtmlString DropDownList(
    this HtmlHelper htmlHelper,
    string name,
    IEnumerable<SelectListItem> selectList,
    string optionLabel,
    IDictionary<string, object> htmlAttributes
)
public:
[ExtensionAttribute]
static MvcHtmlString^ DropDownList(
    HtmlHelper^ htmlHelper,
    String^ name,
    IEnumerable<SelectListItem^>^ selectList,
    String^ optionLabel,
    IDictionary<String^, Object^>^ htmlAttributes
)
static member DropDownList : 
        htmlHelper:HtmlHelper *
        name:string *
        selectList:IEnumerable<SelectListItem> *
        optionLabel:string *
        htmlAttributes:IDictionary<string, Object> -> MvcHtmlString
<ExtensionAttribute>
Public Shared Function DropDownList (
    htmlHelper As HtmlHelper,
    name As String,
    selectList As IEnumerable(Of SelectListItem),
    optionLabel As String,
    htmlAttributes As IDictionary(Of String, Object)
) As MvcHtmlString

Parameters

  • optionLabel
    Type: System.String

    The text for a default empty item. This parameter can be null.

Return Value

Type: System.Web.Mvc.MvcHtmlString

An HTML select element with an option subelement for each item in the list.

Exceptions

Exception Condition
ArgumentException

The name parameter is null or empty.

Remarks

The DropDownList method renders an element that enables the user to select one item from a drop-down list. Each item in the list is a SelectListItem object.

The difference between calling the DropDownList method and using a select element is that the DropDownList 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" }

Return to top

SelectExtensions.DropDownList Method (HtmlHelper, String, IEnumerable<SelectListItem>, String, Object)

Returns a single-selection select element using the specified HTML helper, the name of the form field, the specified list items, an option label, and the specified HTML attributes.

Syntax

public static MvcHtmlString DropDownList(
    this HtmlHelper htmlHelper,
    string name,
    IEnumerable<SelectListItem> selectList,
    string optionLabel,
    object htmlAttributes
)
public:
[ExtensionAttribute]
static MvcHtmlString^ DropDownList(
    HtmlHelper^ htmlHelper,
    String^ name,
    IEnumerable<SelectListItem^>^ selectList,
    String^ optionLabel,
    Object^ htmlAttributes
)
static member DropDownList : 
        htmlHelper:HtmlHelper *
        name:string *
        selectList:IEnumerable<SelectListItem> *
        optionLabel:string *
        htmlAttributes:Object -> MvcHtmlString
<ExtensionAttribute>
Public Shared Function DropDownList (
    htmlHelper As HtmlHelper,
    name As String,
    selectList As IEnumerable(Of SelectListItem),
    optionLabel As String,
    htmlAttributes As Object
) As MvcHtmlString

Parameters

  • optionLabel
    Type: System.String

    The text for a default empty item. This parameter can be null.

  • 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.

Exceptions

Exception Condition
ArgumentException

The name parameter is null or empty.

Remarks

The DropDownList method renders an element that enables the user to select one item from a drop-down list. Each item in the list is a SelectListItem object.

The difference between calling the DropDownList method and using a select element is that the DropDownList 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" }

Return to top

SelectExtensions.DropDownList Method (HtmlHelper, String, String)

Returns a single-selection select element using the specified HTML helper, the name of the form field, and an option label.

Syntax

public static MvcHtmlString DropDownList(
    this HtmlHelper htmlHelper,
    string name,
    string optionLabel
)
public:
[ExtensionAttribute]
static MvcHtmlString^ DropDownList(
    HtmlHelper^ htmlHelper,
    String^ name,
    String^ optionLabel
)
static member DropDownList : 
        htmlHelper:HtmlHelper *
        name:string *
        optionLabel:string -> MvcHtmlString
<ExtensionAttribute>
Public Shared Function DropDownList (
    htmlHelper As HtmlHelper,
    name As String,
    optionLabel As String
) As MvcHtmlString

Parameters

  • optionLabel
    Type: System.String

    The text for a default empty item. This parameter can be null.

Return Value

Type: System.Web.Mvc.MvcHtmlString

An HTML select element with an option subelement for each item in the list.

Exceptions

Exception Condition
ArgumentException

The name parameter is null or empty.

Remarks

The DropDownList method renders an element that enables the user to select one item from a drop-down list. Each item in the list is a SelectListItem object.

The difference between calling the DropDownList method and using a select element is that the DropDownList method is designed to make it easy to bind to view data or model data.

Return to top