InputExtensions.RadioButton Method (HtmlHelper, String, 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 _
) As MvcHtmlString
public static MvcHtmlString RadioButton(
this HtmlHelper htmlHelper,
string name,
Object value
)
[ExtensionAttribute]
public:
static MvcHtmlString^ RadioButton(
HtmlHelper^ htmlHelper,
String^ name,
Object^ value
)
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 and the ViewDataDictionary key that is used to look up the value.
- 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.
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 Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Exceptions
| Exception | Condition |
|---|---|
| ArgumentException | The name parameter is null reference (Nothing in Visual Basic) or empty. |
| ArgumentNullException | The value parameter is 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.