Export (0) Print
Expand All

InputExtensions.CheckBox Method (HtmlHelper, String)

Returns a check box input element by using the specified HTML helper and the name of the form field.

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

'Declaration
<ExtensionAttribute> _
Public Shared Function CheckBox ( _
	htmlHelper As HtmlHelper, _
	name As String _
) As MvcHtmlString
'Usage
Dim htmlHelper As HtmlHelper 
Dim name As String 
Dim returnValue As MvcHtmlString 

returnValue = htmlHelper.CheckBox(name)

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.

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 http://msdn.microsoft.com/en-us/library/bb384936(v=vs.108).aspx or http://msdn.microsoft.com/en-us/library/bb383977(v=vs.108).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:
© 2014 Microsoft