org.symbian.tools.wrttools.doc.WRTKit/html/WRTKit_TextArea_Class-GUID-137b9641-f3a5-4fc0-bf30-017533e2ad69.html
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en" xml:lang="en">
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<meta name="copyright" content="(C) Copyright 2005" />
<meta name="DC.rights.owner" content="(C) Copyright 2005" />
<meta content="concept" name="DC.Type" />
<meta name="DC.Title" content="WRTKit TextArea Class" />
<meta scheme="URI" name="DC.Relation" content="WRTKit_API_Reference-GUID-00e47c27-0a1a-443f-ae85-cf3381635170.html" />
<meta content="XHTML" name="DC.Format" />
<meta content="GUID-137B9641-F3A5-4FC0-BF30-017533E2AD69" name="DC.Identifier" />
<meta content="en" name="DC.Language" />
<link href="commonltr.css" type="text/css" rel="stylesheet" />
<title>
WRTKit TextArea Class</title>
</head>
<body id="GUID-137B9641-F3A5-4FC0-BF30-017533E2AD69"><a name="GUID-137B9641-F3A5-4FC0-BF30-017533E2AD69"><!-- --></a>
<h1 class="topictitle1">
WRTKit TextArea Class</h1>
<div>
<div class="section"><h2 class="sectiontitle">
Description</h2>
<p>
The TextArea class implements a multi-line text entry control. The control
is useful for situations when users need to enter long text.
</p>
<div class="fignone" id="GUID-137B9641-F3A5-4FC0-BF30-017533E2AD69__GUID-25E398AD-F232-4229-BD3C-6B79AE4A7C72"><a name="GUID-137B9641-F3A5-4FC0-BF30-017533E2AD69__GUID-25E398AD-F232-4229-BD3C-6B79AE4A7C72"><!-- --></a><span class="figcap">Figure 1.
TextArea control</span>
<br /><img src="TextArea_Control_Screenshot_1.png" /><br />
</div>
</div>
<div class="section"><h2 class="sectiontitle">
Inherits from</h2>
<p>
<a href="WRTKit_TextEntryControl_Class-GUID-07359ff7-6015-4d2c-a9bf-b345fcf49090.html">
TextEntryControl</a>
</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="WRTKit_API_Reference-GUID-00e47c27-0a1a-443f-ae85-cf3381635170.html">WRTKit API Reference</a></div>
</div>
</div>
<div class="nested1" id="GUID-80E82CC8-6F1A-4E55-A7F4-715E7DFE856E"><a name="GUID-80E82CC8-6F1A-4E55-A7F4-715E7DFE856E"><!-- --></a>
<h2 class="topictitle2">
Constructor</h2>
<div>
<div class="section"><h3 class="sectiontitle">
Syntax</h3>
<pre>
[TextArea] new TextArea(String id, String caption, String text, Integer rows)</pre>
</div>
<div class="section"><h3 class="sectiontitle">
Description</h3>
<p>
Creates a new instance of the TextArea class.
</p>
</div>
<div class="section"><h3 class="sectiontitle">
Arguments</h3>
<br /><ul>
<li>
<p>
id</p>
<p>
Unique identifier for the control. Can be retrieved using the id property defined
in the UIElement class that this control inherits from. Useful for example to
identify the source of an event in event callback functions or to apply a CSS
rule to only this particular control. The identifier can be null, in which case
no id will be set for the control.
</p>
</li>
<li>
<p>
caption</p>
<p>
The caption text for the control. A null caption can be used to hide the
caption area. The value is an XHTML string.
</p>
</li>
<li>
<p>
text</p>
<p>
The text to display in the text area. If the argument is omitted or null then
the text area will not contain any text when created.
The value is a plain text string (not XHTML).
</p>
</li>
<li>
<p>
rows</p>
<p>
The argument specifies how many rows the text area should have. If omitted the
text area will default to have 3 rows of text. Note that it is still possible
to enter more than 3 lines of text. The rows define the height of the text area
and thus how many lines of text are visible without scrolling.
</p>
</li>
</ul>
</div>
<div class="section"><h3 class="sectiontitle">
Return value</h3>
<p>
A new instance of the TextArea class.
</p>
</div>
</div>
</div>
</body>
</html>