Version: current

# Class TextareaField

TextareaField creates a multi-line text field, allowing more data to be entered than a standard text field. It creates the <textarea> tag in the form HTML.

  Object
  ViewableData implements IteratorAggregate
  RequestHandler
  FormField
  TextareaField

### Direct known subclasses

`HtmlEditorField`, `SimpleHTMLEditorField`, `SimpleTinyMCEField`, `SimpleWysiwygField`

Package: forms\fields-basic
Located at sapphire/forms/TextareaField.php

## Methods summary

`public` | # `__construct( mixed $name, mixed $title = null, mixed $rows = 5, mixed $cols = 20, mixed $value = "", mixed $form = null )` Create a new textarea field. Create a new textarea field. #### Parameters $name $name Field name $title $title Field title $rows $rows The number of rows $cols $cols The number of columns $value $value The current value $form $form The parent form. Auto-set when the field is placed in a form. #### Overrides `FormField::__construct`
`public HTML` | # `Field( )` Create the <textarea> or <span> HTML tag with the attributes for this instance of TextareaField. This makes use of FormField->createTag() functionality. Create the <textarea> or <span> HTML tag with the attributes for this instance of TextareaField. This makes use of FormField->createTag() functionality. #### Returns `HTML` code for the textarea OR span element #### Overrides `FormField::Field`
`public` | # `performReadonlyTransformation( )` Performs a readonly transformation on this field. You should still be able to copy from this field, and it should still send when you submit the form it's attached to. The element shouldn't be both disabled and readonly at the same time. Performs a readonly transformation on this field. You should still be able to copy from this field, and it should still send when you submit the form it's attached to. The element shouldn't be both disabled and readonly at the same time. #### Overrides `FormField::performReadonlyTransformation`
`public` | # `performDisabledTransformation( )` Performs a disabled transformation on this field. You shouldn't be able to copy from this field, and it should not send any data when you submit the form it's attached to. The element shouldn't be both disabled and readonly at the same time. Performs a disabled transformation on this field. You shouldn't be able to copy from this field, and it should not send any data when you submit the form it's attached to. The element shouldn't be both disabled and readonly at the same time. #### Overrides `FormField::performDisabledTransformation`
`public` | # `Type( )` Returns the field type - used by templates. The field type is the class name with the word Field dropped off the end, all lowercase. It's handy for assigning HTML classes. Returns the field type - used by templates. The field type is the class name with the word Field dropped off the end, all lowercase. It's handy for assigning HTML classes. #### Overrides `FormField::Type`
`public` | # `setRows( integer $rows )` Set the number of rows in the textarea Set the number of rows in the textarea #### Parameters $rows int
`public` | # `setColumns( integer $cols )` Set the number of columns in the textarea Set the number of columns in the textarea #### Parameters $cols int

### Methods inherited from FormField

`FieldHolder()`, `LeftTitle()`, `Link()`, `Message()`, `MessageType()`, `Name()`, `Required()`, `RightTitle()`, `SmallFieldHolder()`, `Title()`, `Value()`, `addExtraAttribute()`, `addExtraClass()`, `allowHTML5()`, `allow_html5()`, `attrName()`, `attrTitle()`, `attrValue()`, `createTag()`, `dataValue()`, `debug()`, `describe()`, `extraClass()`, `fieldHolderTemplates()`, `fieldTemplates()`, `forTemplate()`, `getCustomValidationMessage()`, `getExtraClasses()`, `getForm()`, `getHTML5Attribute()`, `getTabIndex()`, `getTabIndexHTML()`, `hasClass()`, `hasData()`, `id()`, `isComposite()`, `isDisabled()`, `isReadonly()`, `jsValidation()`, `name_to_label()`, `removeExtraAttribute()`, `removeExtraClass()`, `rootFieldSet()`, `saveInto()`, `securityTokenEnabled()`, `setAutocomplete()`, `setContainerFieldSet()`, `setCustomValidationMessage()`, `setDisabled()`, `setError()`, `setFieldHolderTemplate()`, `setForm()`, `setHTML5Attribute()`, `setLeftTitle()`, `setName()`, `setReadonly()`, `setRightTitle()`, `setSmallFieldHolderTemplate()`, `setTabIndex()`, `setTemplate()`, `setTitle()`, `setValue()`, `smallFieldHolderTemplates()`, `transform()`, `useHTML5()`, `use_html5()`, `validate()`

### Methods inherited from RequestHandler

`allowedActions()`, `checkAccessAction()`, `getRequest()`, `handleRequest()`, `hasAction()`, `httpError()`

### Methods inherited from ViewableData

`ATT_val()`, `BaseHref()`, `CSSClasses()`, `ColumnBreak()`, `ColumnCalc()`, `ColumnNumber()`, `ColumnPad()`, `ColumnPos()`, `CurrentMember()`, `CurrentPage()`, `Debug()`, `Even()`, `EvenOdd()`, `First()`, `FirstLast()`, `HasPerm()`, `IsAjax()`, `JS_val()`, `Last()`, `Me()`, `Middle()`, `MiddleString()`, `Modulus()`, `MultipleOf()`, `Odd()`, `Pos()`, `RAW_val()`, `SQL_val()`, `ThemeDir()`, `ThemeName()`, `Top()`, `TotalItems()`, `XML_val()`, `__get()`, `__isset()`, `__set()`, `buildCastingCache()`, `cachedCall()`, `castingClass()`, `castingHelper()`, `castingHelperPair()`, `castingObjectCreator()`, `castingObjectCreatorPair()`, `customise()`, `defineMethods()`, `escapeTypeForField()`, `getField()`, `getIterator()`, `getSecurityID()`, `getXMLValues()`, `hasField()`, `hasValue()`, `i18nLocale()`, `iteratorProperties()`, `obj()`, `renderWith()`, `setCustomisedObj()`, `setField()`

### Methods inherited from Object

`__call()`, `__toString()`, `__wakeup()`, `addMethodsFrom()`, `addStaticVars()`, `addWrapperMethod()`, `add_extension()`, `add_static_var()`, `allMethodNames()`, `cacheToFile()`, `cacheToFileWithArgs()`, `clearCache()`, `combined_static()`, `create()`, `createMethod()`, `create_from_string()`, `exists()`, `extInstance()`, `extend()`, `getCustomClass()`, `getExtensionInstance()`, `getExtensionInstances()`, `get_extensions()`, `get_static()`, `hasExtension()`, `hasMethod()`, `has_extension()`, `invokeWithExtensions()`, `is_a()`, `loadCache()`, `parentClass()`, `parse_class_spec()`, `remove_extension()`, `sanitiseCachename()`, `saveCache()`, `set_stat()`, `set_static()`, `set_uninherited()`, `stat()`, `strong_create()`, `uninherited()`, `uninherited_static()`, `useCustomClass()`

### Magic methods summary

## Properties summary

`protected mixed` | $rows | #
`protected mixed` | $cols | #
`protected boolean` | $disabled | # boolean boolean
`protected boolean` | $readonly | # boolean boolean

### Properties inherited from FormField

`$autocomplete`, `$containerFieldSet`, `$customValidationMessage`, `$description`, `$dontEscape`, `$extraAttributes`, `$extraClass`, `$extraClasses`, `$fieldHTML5`, `$fieldHolderTemplate`, `$form`, `$html5Attributes`, `$leftTitle`, `$message`, `$messageType`, `$name`, `$possible_autocomplete_values`, `$rightTitle`, `$smallFieldHolderTemplate`, `$tabIndex`, `$template`, `$title`, `$use_html5`, `$value`

### Properties inherited from RequestHandler

`$allowed_actions`, `$brokenOnConstruct`, `$request`, `$url_handlers`

### Properties inherited from ViewableData

`$casting`, `$customisedObject`, `$default_cast`, `$failover`, `$iteratorPos`, `$iteratorTotalItems`

### Properties inherited from Object

`$class`, `$extension_instances`, `$extensions`

[Raise a SilverStripe Framework issue/bug](https://github.com/silverstripe/silverstripe-framework/issues/new)
- [Raise a SilverStripe CMS issue/bug](https://github.com/silverstripe/silverstripe-cms/issues/new)
- Please use the Silverstripe Forums to ask development related questions. -