diff -r ab8569330011 -r 46f364ef3f5d org.symbian.wrttools.doc.WRTKit/html/WRTKit_TextArea_Class-GUID-137b9641-f3a5-4fc0-bf30-017533e2ad69.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/org.symbian.wrttools.doc.WRTKit/html/WRTKit_TextArea_Class-GUID-137b9641-f3a5-4fc0-bf30-017533e2ad69.html Thu Mar 04 17:06:37 2010 -0800 @@ -0,0 +1,188 @@ + + + + + + + + + + + + + + +WRTKit TextArea Class + + + + + +

+WRTKit TextArea Class

+ +
+ +

+Description

+ + +

+ + The TextArea class implements a multi-line text entry control. The control + is useful for situations when users need to enter long text. +

+ +
Figure 1. +TextArea control + + +

+
+ +
+ +

+Inherits from

+ + +

+ + +TextEntryControl +

+ +
+ +
+ +
+ +
+
+ +

+Constructor

+ +
+ +

+Syntax

+ + +
+[TextArea] new TextArea(String id, String caption, String text, Integer rows)
+ +
+ +

+Description

+ + +

+ + Creates a new instance of the TextArea class. +

+ +
+ +

+Arguments

+ + +
    + +
  • + +

    +id

    + + + +

    + + 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. +

    + + +
  • + +
  • + +

    +caption

    + + + +

    + + The caption text for the control. A null caption can be used to hide the + caption area. The value is an XHTML string. +

    + + +
  • + +
  • + +

    +text

    + + + +

    + + 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). +

    + + +
  • + +
  • + +

    +rows

    + + + +

    + + 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. +

    + + +
  • + +
+ +
+ +

+Return value

+ + +

+ + A new instance of the TextArea class. +

+ +
+ +
+ +
+ + + + \ No newline at end of file