InputExtensions.TextBox Method

 

Returns a text input element.

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

NameDescription
System_CAPS_pubmethodSystem_CAPS_staticTextBox(HtmlHelper, String)

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

System_CAPS_pubmethodSystem_CAPS_staticTextBox(HtmlHelper, String, Object)

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

System_CAPS_pubmethodSystem_CAPS_staticTextBox(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.

System_CAPS_pubmethodSystem_CAPS_staticTextBox(HtmlHelper, String, Object, Object)

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

System_CAPS_pubmethodSystem_CAPS_staticTextBox(HtmlHelper, String, Object, String)

Returns a text input element.

System_CAPS_pubmethodSystem_CAPS_staticTextBox(HtmlHelper, String, Object, String, IDictionary<String, Object>)

Returns a text input element.

System_CAPS_pubmethodSystem_CAPS_staticTextBox(HtmlHelper, String, Object, String, Object)

Returns a text input element.

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.

Return to top

InputExtensions.TextBox Method (HtmlHelper, String)

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

public static MvcHtmlString TextBox(
	this HtmlHelper htmlHelper,
	string 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 and the ViewDataDictionary key that is used to look up the value.

Return Value

Type: System.Web.Mvc.MvcHtmlString

An input element whose type attribute is set to "text".

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.

Return to top

InputExtensions.TextBox Method (HtmlHelper, String, Object)

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

public static MvcHtmlString TextBox(
	this HtmlHelper htmlHelper,
	string name,
	object value
)

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. The value is retrieved in this order - the ModelStateDictionary object, the value of this parameter, the ViewDataDictionary object, and lastly, a value attribute in the html attributes.

Return Value

Type: System.Web.Mvc.MvcHtmlString

An input element whose type attribute is set to "text".

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.

Return to top

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.

public static MvcHtmlString TextBox(
	this HtmlHelper htmlHelper,
	string name,
	object value,
	IDictionary<stringobject> 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. The value is retrieved in this order - the ModelStateDictionary object, the value of this parameter, the ViewDataDictionary object, and lastly, a value attribute in the html attributes.

htmlAttributes
Type: System.Collections.Generic.IDictionary<StringObject>

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

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" }
Return to top

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

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

public static MvcHtmlString TextBox(
	this HtmlHelper htmlHelper,
	string name,
	object value,
	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. The value is retrieved in this order - the ModelStateDictionary object, the value of this parameter, the ViewDataDictionary object, and lastly, a value attribute in the html attributes.

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

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" }
Return to top

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

Returns a text input element.

public static MvcHtmlString TextBox(
	this HtmlHelper htmlHelper,
	string name,
	object value,
	string format
)

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.

value
Type: System.Object

The value of the text input element. The value is retrieved in this order - the ModelStateDictionary object, the value of this parameter, the ViewDataDictionary object, and lastly, a value attribute in the html attributes.

format
Type: System.String

A string that is used to format the input.

Return Value

Type: System.Web.Mvc.MvcHtmlString

An input element whose type attribute is set to "text".

Return to top

InputExtensions.TextBox Method (HtmlHelper, String, Object, String, IDictionary<String, Object>)

Returns a text input element.

public static MvcHtmlString TextBox(
	this HtmlHelper htmlHelper,
	string name,
	object value,
	string format,
	IDictionary<stringobject> 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. The value is retrieved in this order - the ModelStateDictionary object, the value of this parameter, the ViewDataDictionary object, and lastly, a value attribute in the html attributes.

format
Type: System.String

A string that is used to format the input.

htmlAttributes
Type: System.Collections.Generic.IDictionary<StringObject>

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

Return to top

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

Returns a text input element.

public static MvcHtmlString TextBox(
	this HtmlHelper htmlHelper,
	string name,
	object value,
	string format,
	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. The value is retrieved in this order - the ModelStateDictionary object, the value of this parameter, the ViewDataDictionary object, and lastly, a value attribute in the html attributes.

format
Type: System.String

A string that is used to format the input.

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

Return to top
Show: