InputExtensions.TextBox Method (HtmlHelper, String, Object, IDictionary<String, Object>)
Returns a text 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)
Syntax
'Declaration
<ExtensionAttribute> _
Public Shared Function TextBox ( _
htmlHelper As HtmlHelper, _
name As String, _
value As Object, _
htmlAttributes As IDictionary(Of String, Object) _
) As MvcHtmlString
public static MvcHtmlString TextBox(
this HtmlHelper htmlHelper,
string name,
Object value,
IDictionary<string, Object> htmlAttributes
)
[ExtensionAttribute]
public:
static MvcHtmlString^ TextBox(
HtmlHelper^ htmlHelper,
String^ name,
Object^ value,
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 and the ViewDataDictionary key that is used to look up the value.
- value
Type: System.Object
The value of the text input element. If this value is null reference (Nothing in Visual Basic), the value of the element is retrieved from the ViewDataDictionary object. If no value exists there, the value is retrieved from the ModelStateDictionary object.
- 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 "text".
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
The difference between calling the TextBox method and using an input element is that the TextBox 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 "text", you might provide the following anonymous object:
new { id = "text1", maxlength="20", size="15" }
New With { .id = "text1", .maxlength="20", .size="15" }