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

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

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


<ExtensionAttribute> _
Public Shared Function CheckBox ( _
    htmlHelper As HtmlHelper, _
    name As String, _
    isChecked As Boolean, _
    htmlAttributes As Object _
) As MvcHtmlString
Dim htmlHelper As HtmlHelper 
Dim name As String 
Dim isChecked As Boolean 
Dim htmlAttributes As Object 
Dim returnValue As MvcHtmlString 

returnValue = htmlHelper.CheckBox(name, _
    isChecked, htmlAttributes)
public static MvcHtmlString CheckBox(
    this HtmlHelper htmlHelper,
    string name,
    bool isChecked,
    Object htmlAttributes
static MvcHtmlString^ CheckBox(
    HtmlHelper^ htmlHelper, 
    String^ name, 
    bool isChecked, 
    Object^ htmlAttributes
static member CheckBox : 
        htmlHelper:HtmlHelper * 
        name:string * 
        isChecked:bool * 
        htmlAttributes:Object -> MvcHtmlString
public static function CheckBox(
    htmlHelper : HtmlHelper, 
    name : String, 
    isChecked : boolean, 
    htmlAttributes : Object
) : MvcHtmlString


  • isChecked
    Type: System.Boolean

    true to select the check box; 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 "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 or


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

See Also


InputExtensions Class

CheckBox Overload

System.Web.Mvc.Html Namespace