HtmlHelper.RadioButton Method (String, Object, Boolean, IDictionary<String, Object>)

Returns an HTML radio button control that has the specified name, value, default selected status, and custom attributes defined by an attribute dictionary.

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

Syntax

'Declaration
Public Function RadioButton ( _
    name As String, _
    value As Object, _
    isChecked As Boolean, _
    htmlAttributes As IDictionary(Of String, Object) _
) As IHtmlString
'Usage
Dim instance As HtmlHelper 
Dim name As String 
Dim value As Object 
Dim isChecked As Boolean 
Dim htmlAttributes As IDictionary(Of String, Object)
Dim returnValue As IHtmlString 

returnValue = instance.RadioButton(name, _
    value, isChecked, htmlAttributes)
public IHtmlString RadioButton(
    string name,
    Object value,
    bool isChecked,
    IDictionary<string, Object> htmlAttributes
)
public:
IHtmlString^ RadioButton(
    String^ name, 
    Object^ value, 
    bool isChecked, 
    IDictionary<String^, Object^>^ htmlAttributes
)
member RadioButton : 
        name:string * 
        value:Object * 
        isChecked:bool * 
        htmlAttributes:IDictionary<string, Object> -> IHtmlString
public function RadioButton(
    name : String, 
    value : Object, 
    isChecked : boolean, 
    htmlAttributes : IDictionary<String, Object>
) : IHtmlString

Parameters

  • name
    Type: System.String
    The value to assign to the name attribute of the HTML control element. The name attribute defines the group that the radio button belongs to.
  • value
    Type: System.Object
    The value to assign to the value attribute of the element.
  • isChecked
    Type: System.Boolean
    true to indicate that the control is selected; otherwise, false.

Return Value

Type: System.Web.IHtmlString
The HTML markup that represents the radio button control.

Exceptions

Exception Condition
ArgumentException

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

Remarks

The returned markup consists of an HTML input element in one of the following forms:

<input type="radio" name="name" value="value" checked="checked" ...htmlAttributes... />

isChecked is true.

<input type="radio" name="name" value="value "...htmlAttributes... />

isChecked is false.

See Also

Reference

HtmlHelper Class

RadioButton Overload

System.Web.WebPages.Html Namespace