HtmlHelper.TextArea Method (String, String, Object)
Returns an HTML multi-line text input (text area) control that has the specified name, value, and custom attributes defined by an attribute object.
Namespace: System.Web.WebPages.Html
Assembly: System.Web.WebPages (in System.Web.WebPages.dll)
Syntax
'Declaration
Public Function TextArea ( _
name As String, _
value As String, _
htmlAttributes As Object _
) As IHtmlString
'Usage
Dim instance As HtmlHelper
Dim name As String
Dim value As String
Dim htmlAttributes As Object
Dim returnValue As IHtmlString
returnValue = instance.TextArea(name, _
value, htmlAttributes)
public IHtmlString TextArea(
string name,
string value,
Object htmlAttributes
)
public:
IHtmlString^ TextArea(
String^ name,
String^ value,
Object^ htmlAttributes
)
member TextArea :
name:string *
value:string *
htmlAttributes:Object -> IHtmlString
public function TextArea(
name : String,
value : String,
htmlAttributes : Object
) : IHtmlString
Parameters
- name
Type: System.String
The value to assign to the name attribute of the HTML textarea element.
- value
Type: System.String
The text to display.
- htmlAttributes
Type: System.Object
An object that contains custom attributes for the element. The attribute names and values are retrieved through reflection by examining the properties of the object.
Return Value
Type: System.Web.IHtmlString
The HTML markup that represents the text area control.
Exceptions
Exception | Condition |
---|---|
ArgumentException | name is null reference (Nothing in Visual Basic) or empty. |
Remarks
The returned markup consists of an HTML textarea element in the following form:
<textarea name="name" rows="2" cols="20" ...htmlAttributes...>
value
</textarea>