Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

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

Returns a hidden input element by using the specified HTML helper, the name of the form field, the value, and the HTML attributes.

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

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

returnValue = htmlHelper.Hidden(name, _
	value, 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 hidden input element The value of the element is retrieved from the ViewDataDictionary object. If no value exists there, the value is retrieved from the ModelStateDictionary object. If the element is not found in the ViewDataDictionary object or the ModelStateDictionary object, the value parameter is used.

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

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

The difference between calling the Hidden method and using an input element is that the Hidden 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 "hidden", you might provide the following anonymous object:

New With { .id = "hidden1" }
Show:
© 2015 Microsoft