InputExtensions.CheckBox Method (HtmlHelper, String, Boolean, IDictionary<String, Object>)
Returns a check box input element by using the specified HTML helper, the name of the form field, a value to indicate whether the check box is selected, and the HTML attributes.
Namespace: System.Web.Mvc.Html
Assembly: System.Web.Mvc (in System.Web.Mvc.dll)
Syntax
'Declaration
<ExtensionAttribute> _
Public Shared Function CheckBox ( _
htmlHelper As HtmlHelper, _
name As String, _
isChecked As Boolean, _
htmlAttributes As IDictionary(Of String, Object) _
) As MvcHtmlString
public static MvcHtmlString CheckBox(
this HtmlHelper htmlHelper,
string name,
bool isChecked,
IDictionary<string, Object> htmlAttributes
)
[ExtensionAttribute]
public:
static MvcHtmlString^ CheckBox(
HtmlHelper^ htmlHelper,
String^ name,
bool isChecked,
IDictionary<String^, 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.
- isChecked
Type: System.Boolean
true to select the check box; otherwise, false.
- htmlAttributes
Type: System.Collections.Generic.IDictionary<String, 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 "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 Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Remarks
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.
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 "checkbox", you might provide the following anonymous object:
new { id = "checkbox1" }
New With { .id = "checkbox1" }