HtmlHelper.TextArea Method (String, String, Int32, Int32, IDictionary<String, Object>)

Returns an HTML multi-line text input (text area) control that has the specified name, value, row attribute, col attribute, and custom attributes defined by an attribute dictionary.

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, _
    rows As Integer, _
    columns As Integer, _
    htmlAttributes As IDictionary(Of String, Object) _
) As IHtmlString
'Usage
Dim instance As HtmlHelper 
Dim name As String 
Dim value As String 
Dim rows As Integer 
Dim columns As Integer 
Dim htmlAttributes As IDictionary(Of String, Object)
Dim returnValue As IHtmlString 

returnValue = instance.TextArea(name, _
    value, rows, columns, htmlAttributes)
public IHtmlString TextArea(
    string name,
    string value,
    int rows,
    int columns,
    IDictionary<string, Object> htmlAttributes
)
public:
IHtmlString^ TextArea(
    String^ name, 
    String^ value, 
    int rows, 
    int columns, 
    IDictionary<String^, Object^>^ htmlAttributes
)
member TextArea : 
        name:string * 
        value:string * 
        rows:int * 
        columns:int * 
        htmlAttributes:IDictionary<string, Object> -> IHtmlString
public function TextArea(
    name : String, 
    value : String, 
    rows : int, 
    columns : int, 
    htmlAttributes : IDictionary<String, Object>
) : IHtmlString

Parameters

  • name
    Type: System.String
    The value to assign to the name attribute of the HTML textarea element.
  • rows
    Type: System.Int32
    The value to assign to the rows attribute of the element.
  • columns
    Type: System.Int32
    The value to assign to the cols attribute of the element.

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="rows" cols="columns" ...htmlAttributes...>
  value
</textarea>

See Also

Reference

HtmlHelper Class

TextArea Overload

System.Web.WebPages.Html Namespace