org.symbian.wrttools.doc.WRTKit/html/WRTKit_TextEntryControl_Class-GUID-07359ff7-6015-4d2c-a9bf-b345fcf49090.html
author tasneems@symbian.org
Thu, 04 Mar 2010 15:42:37 -0800
changeset 220 41890dfa56f5
permissions -rw-r--r--
Fixed 2046 - added support for WRTKit help

<?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 TextEntryControl 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-07359FF7-6015-4D2C-A9BF-B345FCF49090" name="DC.Identifier" />
<meta content="en" name="DC.Language" />
<link href="commonltr.css" type="text/css" rel="stylesheet" />
<title>
WRTKit TextEntryControl Class</title>
</head>
<body id="GUID-07359FF7-6015-4D2C-A9BF-B345FCF49090"><a name="GUID-07359FF7-6015-4D2C-A9BF-B345FCF49090"><!-- --></a>



    <h1 class="topictitle1">
WRTKit TextEntryControl Class</h1>

    <div>

        <div class="section"><h2 class="sectiontitle">
Description</h2>

            
            <p>

                The TextEntryControl class is an abstract base class for controls that let a user
                enter text. Don't instantiate TextEntryControl directly but rather one of its subclasses.
            </p>

        </div>

        <div class="section"><h2 class="sectiontitle">
Inherits from</h2>

            
            <p>

                <a href="WRTKit_Control_Class-GUID-6ddb8154-3fed-40fc-b282-85e6d3ad494f.html">
Control</a>
            </p>

        </div>

        <div class="section"><h2 class="sectiontitle">
Events</h2>

            
            <br /><ul>

                <li>

                    <p>
TextChanged</p>

                    

                        <p>

                            This event is fired when the user enters new text in the control.
                        </p>

                    
                </li>

            </ul>

        </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-4755F522-0799-4BE5-92DD-A651AFB8A1BE"><a name="GUID-4755F522-0799-4BE5-92DD-A651AFB8A1BE"><!-- --></a>

        <h2 class="topictitle2">
getText()</h2>

        <div>

            <div class="section"><h3 class="sectiontitle">
Syntax</h3>

                
                <pre>
[String] TextEntryControl.getText(void)</pre>

            </div>

            <div class="section"><h3 class="sectiontitle">
Description</h3>

                
                <p>

                    Retrieves the current text of the text entry control.
                    The value is a plain text string (not XHTML).
                </p>

            </div>

            <div class="section"><h3 class="sectiontitle">
Arguments</h3>

                
                <p>

                    This method does not take any arguments.
                </p>

            </div>

            <div class="section"><h3 class="sectiontitle">
Return value</h3>

                
                <p>

                    The current text of the text entry control.
                </p>

            </div>

        </div>

    </div>

    <div class="nested1" id="GUID-0E3FE1F0-6ACA-4DFF-B694-281954916B27"><a name="GUID-0E3FE1F0-6ACA-4DFF-B694-281954916B27"><!-- --></a>

        <h2 class="topictitle2">
setText()</h2>

        <div>

            <div class="section"><h3 class="sectiontitle">
Syntax</h3>

                
                <pre>
[void] TextEntryControl.setText(String text)</pre>

            </div>

            <div class="section"><h3 class="sectiontitle">
Description</h3>

                
                <p>

                    Sets the text value of the text entry control. The text is displayed in the
                    editable area of the control and can be edited by the user provided that
                    the control is not disabled. Setting a text value of null results in no
                    text being shown. The value is a plain text string (not XHTML).
                </p>

            </div>

            <div class="section"><h3 class="sectiontitle">
Arguments</h3>

                
                <br /><ul>

                    <li>

                        <p>
text</p>

                        

                            <p>

                                The text value to set to the text entry control. A value of null
                                results in no text being shown.
                            </p>

                        
                    </li>

                </ul>

            </div>

            <div class="section"><h3 class="sectiontitle">
Return value</h3>

                
                <p>

                    This method does not return a value.
                </p>

            </div>

        </div>

    </div>


</body>
</html>