TextAreaExtensions.TextArea Method (HtmlHelper, String, IDictionary<String, Object>)
Returns the specified textarea element by using the specified HTML helper, the name of the form field, and the specified HTML attributes.
Namespace: System.Web.Mvc.Html
Assembly: System.Web.Mvc (in System.Web.Mvc.dll)
Syntax
'Declaration
<ExtensionAttribute> _
Public Shared Function TextArea ( _
htmlHelper As HtmlHelper, _
name As String, _
htmlAttributes As IDictionary(Of String, Object) _
) As MvcHtmlString
public static MvcHtmlString TextArea(
this HtmlHelper htmlHelper,
string name,
IDictionary<string, Object> htmlAttributes
)
[ExtensionAttribute]
public:
static MvcHtmlString^ TextArea(
HtmlHelper^ htmlHelper,
String^ name,
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 to return.
- 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
The textarea element.
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 TextArea method and using a textarea element is that the TextArea 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 a textarea element, you might provide the following anonymous object:
new {id = "textarea1", cols="20", rows="5", wrap="virtual"}
New With {.id = "textarea1", .cols="20", .rows="5", .wrap="virtual"}