1 <?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"> |
|
2 <html lang="en" xml:lang="en"> |
|
3 <head> |
|
4 <meta content="text/html; charset=utf-8" http-equiv="Content-Type" /> |
|
5 <meta name="copyright" content="(C) Copyright 2005" /> |
|
6 <meta name="DC.rights.owner" content="(C) Copyright 2005" /> |
|
7 <meta content="concept" name="DC.Type" /> |
|
8 <meta name="DC.Title" content="WRTKit TextArea Class" /> |
|
9 <meta scheme="URI" name="DC.Relation" content="WRTKit_API_Reference-GUID-00e47c27-0a1a-443f-ae85-cf3381635170.html" /> |
|
10 <meta content="XHTML" name="DC.Format" /> |
|
11 <meta content="GUID-137B9641-F3A5-4FC0-BF30-017533E2AD69" name="DC.Identifier" /> |
|
12 <meta content="en" name="DC.Language" /> |
|
13 <link href="commonltr.css" type="text/css" rel="stylesheet" /> |
|
14 <title> |
|
15 WRTKit TextArea Class</title> |
|
16 </head> |
|
17 <body id="GUID-137B9641-F3A5-4FC0-BF30-017533E2AD69"><a name="GUID-137B9641-F3A5-4FC0-BF30-017533E2AD69"><!-- --></a> |
|
18 |
|
19 |
|
20 |
|
21 <h1 class="topictitle1"> |
|
22 WRTKit TextArea Class</h1> |
|
23 |
|
24 <div> |
|
25 |
|
26 <div class="section"><h2 class="sectiontitle"> |
|
27 Description</h2> |
|
28 |
|
29 |
|
30 <p> |
|
31 |
|
32 The TextArea class implements a multi-line text entry control. The control |
|
33 is useful for situations when users need to enter long text. |
|
34 </p> |
|
35 |
|
36 <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. |
|
37 TextArea control</span> |
|
38 |
|
39 |
|
40 <br /><img src="TextArea_Control_Screenshot_1.png" /><br /> |
|
41 </div> |
|
42 |
|
43 </div> |
|
44 |
|
45 <div class="section"><h2 class="sectiontitle"> |
|
46 Inherits from</h2> |
|
47 |
|
48 |
|
49 <p> |
|
50 |
|
51 <a href="WRTKit_TextEntryControl_Class-GUID-07359ff7-6015-4d2c-a9bf-b345fcf49090.html"> |
|
52 TextEntryControl</a> |
|
53 </p> |
|
54 |
|
55 </div> |
|
56 |
|
57 </div> |
|
58 |
|
59 <div> |
|
60 <div class="familylinks"> |
|
61 <div class="parentlink"><strong>Parent topic:</strong> <a href="WRTKit_API_Reference-GUID-00e47c27-0a1a-443f-ae85-cf3381635170.html">WRTKit API Reference</a></div> |
|
62 </div> |
|
63 </div> |
|
64 <div class="nested1" id="GUID-80E82CC8-6F1A-4E55-A7F4-715E7DFE856E"><a name="GUID-80E82CC8-6F1A-4E55-A7F4-715E7DFE856E"><!-- --></a> |
|
65 |
|
66 <h2 class="topictitle2"> |
|
67 Constructor</h2> |
|
68 |
|
69 <div> |
|
70 |
|
71 <div class="section"><h3 class="sectiontitle"> |
|
72 Syntax</h3> |
|
73 |
|
74 |
|
75 <pre> |
|
76 [TextArea] new TextArea(String id, String caption, String text, Integer rows)</pre> |
|
77 |
|
78 </div> |
|
79 |
|
80 <div class="section"><h3 class="sectiontitle"> |
|
81 Description</h3> |
|
82 |
|
83 |
|
84 <p> |
|
85 |
|
86 Creates a new instance of the TextArea class. |
|
87 </p> |
|
88 |
|
89 </div> |
|
90 |
|
91 <div class="section"><h3 class="sectiontitle"> |
|
92 Arguments</h3> |
|
93 |
|
94 |
|
95 <br /><ul> |
|
96 |
|
97 <li> |
|
98 |
|
99 <p> |
|
100 id</p> |
|
101 |
|
102 |
|
103 |
|
104 <p> |
|
105 |
|
106 Unique identifier for the control. Can be retrieved using the id property defined |
|
107 in the UIElement class that this control inherits from. Useful for example to |
|
108 identify the source of an event in event callback functions or to apply a CSS |
|
109 rule to only this particular control. The identifier can be null, in which case |
|
110 no id will be set for the control. |
|
111 </p> |
|
112 |
|
113 |
|
114 </li> |
|
115 |
|
116 <li> |
|
117 |
|
118 <p> |
|
119 caption</p> |
|
120 |
|
121 |
|
122 |
|
123 <p> |
|
124 |
|
125 The caption text for the control. A null caption can be used to hide the |
|
126 caption area. The value is an XHTML string. |
|
127 </p> |
|
128 |
|
129 |
|
130 </li> |
|
131 |
|
132 <li> |
|
133 |
|
134 <p> |
|
135 text</p> |
|
136 |
|
137 |
|
138 |
|
139 <p> |
|
140 |
|
141 The text to display in the text area. If the argument is omitted or null then |
|
142 the text area will not contain any text when created. |
|
143 The value is a plain text string (not XHTML). |
|
144 </p> |
|
145 |
|
146 |
|
147 </li> |
|
148 |
|
149 <li> |
|
150 |
|
151 <p> |
|
152 rows</p> |
|
153 |
|
154 |
|
155 |
|
156 <p> |
|
157 |
|
158 The argument specifies how many rows the text area should have. If omitted the |
|
159 text area will default to have 3 rows of text. Note that it is still possible |
|
160 to enter more than 3 lines of text. The rows define the height of the text area |
|
161 and thus how many lines of text are visible without scrolling. |
|
162 </p> |
|
163 |
|
164 |
|
165 </li> |
|
166 |
|
167 </ul> |
|
168 |
|
169 </div> |
|
170 |
|
171 <div class="section"><h3 class="sectiontitle"> |
|
172 Return value</h3> |
|
173 |
|
174 |
|
175 <p> |
|
176 |
|
177 A new instance of the TextArea class. |
|
178 </p> |
|
179 |
|
180 </div> |
|
181 |
|
182 </div> |
|
183 |
|
184 </div> |
|
185 |
|
186 |
|
187 </body> |
|
188 </html> |
|