InputExtensions.RadioButton Method (HtmlHelper, String, Object, Boolean, Object)

Returns a radio button input element that is used to present mutually exclusive options.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function RadioButton ( _
    htmlHelper As HtmlHelper, _
    name As String, _
    value As Object, _
    isChecked As Boolean, _
    htmlAttributes As Object _
) As MvcHtmlString
'Usage
Dim htmlHelper As HtmlHelper 
Dim name As String 
Dim value As Object 
Dim isChecked As Boolean 
Dim htmlAttributes As Object 
Dim returnValue As MvcHtmlString 

returnValue = htmlHelper.RadioButton(name, _
    value, isChecked, htmlAttributes)
public static MvcHtmlString RadioButton(
    this HtmlHelper htmlHelper,
    string name,
    Object value,
    bool isChecked,
    Object htmlAttributes
)
[ExtensionAttribute]
public:
static MvcHtmlString^ RadioButton(
    HtmlHelper^ htmlHelper, 
    String^ name, 
    Object^ value, 
    bool isChecked, 
    Object^ htmlAttributes
)
static member RadioButton : 
        htmlHelper:HtmlHelper * 
        name:string * 
        value:Object * 
        isChecked:bool * 
        htmlAttributes:Object -> MvcHtmlString
public static function RadioButton(
    htmlHelper : HtmlHelper, 
    name : String, 
    value : Object, 
    isChecked : boolean, 
    htmlAttributes : Object
) : MvcHtmlString

Parameters

  • value
    Type: System.Object

    If this radio button is selected, the value of the radio button that is submitted when the form is posted. If the value of the selected radio button in the ViewDataDictionary or the ModelStateDictionary object matches this value, this radio button is selected.

  • isChecked
    Type: System.Boolean

    true to select the radio button; otherwise, false.

  • htmlAttributes
    Type: System.Object

    An object that contains the HTML attributes to set for the element.

Return Value

Type: System.Web.Mvc.MvcHtmlString
An input element whose type attribute is set to "radio".

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

Exceptions

Exception Condition
ArgumentException

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

ArgumentNullException

The value parameter is nulla null reference (Nothing in Visual Basic).

Remarks

The difference between calling the RadioButton method and using an input element is that the RadioButton 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 an input element where type is set to "radio", you might provide the following anonymous object:

new { id = "radio1" }
New With { .id = "radio1" }

See Also

Reference

InputExtensions Class

RadioButton Overload

System.Web.Mvc.Html Namespace