InputExtensions.RadioButton Method

 

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)

NameDescription
System_CAPS_pubmethodSystem_CAPS_staticRadioButton(HtmlHelper, String, Object)

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

System_CAPS_pubmethodSystem_CAPS_staticRadioButton(HtmlHelper, String, Object, Boolean)

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

System_CAPS_pubmethodSystem_CAPS_staticRadioButton(HtmlHelper, String, Object, Boolean, IDictionary<String, Object>)

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

System_CAPS_pubmethodSystem_CAPS_staticRadioButton(HtmlHelper, String, Object, Boolean, Object)

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

System_CAPS_pubmethodSystem_CAPS_staticRadioButton(HtmlHelper, String, Object, IDictionary<String, Object>)

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

System_CAPS_pubmethodSystem_CAPS_staticRadioButton(HtmlHelper, String, Object, Object)

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

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.

Return to top

InputExtensions.RadioButton Method (HtmlHelper, String, Object)

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

public static MvcHtmlString RadioButton(
	this 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

The value of the selected radio button. The value is retrieved in this order - the ModelStateDictionary object, the value of this parameter, the ViewDataDictionary object, and lastly, a value attribute in the html attributes.

Return Value

Type: System.Web.Mvc.MvcHtmlString

An input element whose type attribute is set to "radio".

Exception Condition
ArgumentException

The name parameter is null or empty.

ArgumentNullException

The value parameter is null.

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.

Return to top

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

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

public static MvcHtmlString RadioButton(
	this HtmlHelper htmlHelper,
	string name,
	object value,
	bool isChecked
)

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

The value of the selected radio button. The value is retrieved in this order - the ModelStateDictionary object, the value of this parameter, the ViewDataDictionary object, and lastly, a value attribute in the html attributes.

isChecked
Type: System.Boolean

true to select the radio button; otherwise, false.

Return Value

Type: System.Web.Mvc.MvcHtmlString

An input element whose type attribute is set to "radio".

Exception Condition
ArgumentException

The name parameter is null or empty.

ArgumentNullException

The value parameter is null.

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.

Return to top

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

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

public static MvcHtmlString RadioButton(
	this HtmlHelper htmlHelper,
	string name,
	object value,
	bool isChecked,
	IDictionary<stringobject> htmlAttributes
)

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

The value of the selected radio button. The value is retrieved in this order - the ModelStateDictionary object, the value of this parameter, the ViewDataDictionary object, and lastly, a value attribute in the html attributes.

isChecked
Type: System.Boolean

true to select the radio button; otherwise, false.

htmlAttributes
Type: System.Collections.Generic.IDictionary<StringObject>

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

Exception Condition
ArgumentException

The name parameter is null or empty.

ArgumentNullException

The value parameter is null.

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" }
Return to top

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

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

public static MvcHtmlString RadioButton(
	this HtmlHelper htmlHelper,
	string name,
	object value,
	bool isChecked,
	object htmlAttributes
)

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

The value of the selected radio button. The value is retrieved in this order - the ModelStateDictionary object, the value of this parameter, the ViewDataDictionary object, and lastly, a value attribute in the html attributes.

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

Exception Condition
ArgumentException

The name parameter is null or empty.

ArgumentNullException

The value parameter is null.

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" }
Return to top

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

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

public static MvcHtmlString RadioButton(
	this HtmlHelper htmlHelper,
	string name,
	object value,
	IDictionary<stringobject> htmlAttributes
)

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

The value of the selected radio button. The value is retrieved in this order - the ModelStateDictionary object, the value of this parameter, the ViewDataDictionary object, and lastly, a value attribute in the html attributes.

htmlAttributes
Type: System.Collections.Generic.IDictionary<StringObject>

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

Exception Condition
ArgumentException

The name parameter is null or empty.

ArgumentNullException

The value parameter is null.

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" }
Return to top

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

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

public static MvcHtmlString RadioButton(
	this HtmlHelper htmlHelper,
	string name,
	object value,
	object htmlAttributes
)

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

The value of the selected radio button. The value is retrieved in this order - the ModelStateDictionary object, the value of this parameter, the ViewDataDictionary object, and lastly, a value attribute in the html attributes.

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

Exception Condition
ArgumentException

The name parameter is null or empty.

ArgumentNullException

The value parameter is null.

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" }
Return to top
Show: