InputExtensions.CheckBox Method (HtmlHelper, String, Boolean)

Returns a check box input element by using the specified HTML helper, the name of the form field, and a value to indicate whether the check box is selected.

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

public static MvcHtmlString CheckBox(
	this HtmlHelper htmlHelper,
	string name,
	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.
isChecked
Type: System.Boolean
true to select the check box; otherwise, false. The value of the check box is retrieved in this order - the ModelStateDictionary object, the value of this parameter, the ViewDataDictionary object, and lastly, a checked attribute in the html attributes.

Return Value

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

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.aspx or https://msdn.microsoft.com/en-us/library/bb383977.aspx.

In addition to rendering a check box input element, this method renders a hidden input element so that an unselected check box will return false.

The difference between calling the CheckBox method and using an input element is that the CheckBox method is designed to make it easy to bind to view data or model data.

Show: