org.symbian.tools.wrttools.doc.WRTKit/html/WRTKit_TextField_Class-GUID-799b7dea-1e4d-4147-bc27-acc4b91d8bf9.html
author Eugene Ostroukhov <eugeneo@symbian.org>
Wed, 16 Jun 2010 16:41:16 -0700
changeset 382 0a04e9d28d78
parent 230 7848c135d915
permissions -rw-r--r--
Bug 3014 - New Project Wizard Usability

<?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 TextField 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-799B7DEA-1E4D-4147-BC27-ACC4B91D8BF9" name="DC.Identifier" />
<meta content="en" name="DC.Language" />
<link href="commonltr.css" type="text/css" rel="stylesheet" />
<title>
WRTKit TextField Class</title>
</head>
<body id="GUID-799B7DEA-1E4D-4147-BC27-ACC4B91D8BF9"><a name="GUID-799B7DEA-1E4D-4147-BC27-ACC4B91D8BF9"><!-- --></a>



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

    <div>

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

            
            <p>

                The TextField class implements a single line text entry control. The control
                is useful for situations where text is relatively short and doesn't need to
                span multiple lines. The text field also supports masked entry, which is good
                in situations where passwords or other secret text is entered.
            </p>

            <div class="fignone" id="GUID-799B7DEA-1E4D-4147-BC27-ACC4B91D8BF9__GUID-5FDA8C14-4D9A-444B-9595-54284FB8EB01"><a name="GUID-799B7DEA-1E4D-4147-BC27-ACC4B91D8BF9__GUID-5FDA8C14-4D9A-444B-9595-54284FB8EB01"><!-- --></a><span class="figcap">Figure 1. 
TextField control</span>

                
                <br /><img src="TextField_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-F3525C69-F5C8-4D20-BA8B-6EB52A8003F8"><a name="GUID-F3525C69-F5C8-4D20-BA8B-6EB52A8003F8"><!-- --></a>

        <h2 class="topictitle2">
Constructor</h2>

        <div>

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

                
                <pre>
[TextField] new TextField(String id, String caption, String text, Boolean masked)</pre>

            </div>

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

                
                <p>

                    Creates a new instance of the TextField 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 field. If the argument is omitted or null then
                                the text field will not contain any text when created.
                                The value is a plain text string (not XHTML).
                            </p>

                        
                    </li>

                    <li>

                        <p>
masked</p>

                        

                            <p>

                                If the masked argument is true then the text field will be created in masked
                                text entry mode. If the argument is omitted or false then the control will be
                                created in normal text entry mode.
                            </p>

                        
                    </li>

                </ul>

            </div>

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

                
                <p>

                    A new instance of the TextField class.
                </p>

            </div>

        </div>

    </div>


</body>
</html>