<doc>

<legacy_id>1794</legacy_id>

<name>foundText</name>

<type>function</type>

<syntax>

<example>the foundText</example>

<example>foundText()</example>

</syntax>

<library></library>

<objects>

</objects>

<synonyms>

</synonyms>

<classification>

<category>Database Operations</category>

</classification>

<references>

<command tag="find">find Command</command>

<function tag="clickText">clickText Function</function>

</references>

<history>

<introduced version="1.0">Added.</introduced>

</history>

<platforms>

<mac/>

<windows/>

<linux/>

<ios/>

<android/>

</platforms>

<classes>

<desktop/>

<server/>

<web/>

<mobile/>

</classes>

<security>

</security>

<summary><glossary tag="return">Returns</glossary> the text located by the most recent <command tag="find">find</command> <glossary tag="command">command</glossary>.</summary>

<examples>

<example>the foundText</example>

<example>put the foundText into whichWord</example>

</examples>

<description>

<p>Use the <b>foundText</b> <control_st tag="function">function</control_st> to determine which <keyword tag="word">word</keyword> in the search <keyword tag="string">string</keyword> was found, and whether it matches a whole <keyword tag="word">word</keyword> or a portion of a <keyword tag="word">word</keyword>.</p><p/><p><b>Value:</b></p><p>The <b>foundText</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> the text that was found.</p><p/><p><b>Comments:</b></p><p>Depending on what form of the <b>find</b> <glossary tag="command">command</glossary> you used, the text found may be different from the text you searched for. For example, the command</p><p><code> find "hurl"</code></p><p>can find any word that starts with the string "hurl", such as "hurling" or "hurler". In this case, the entire <keyword tag="word">word</keyword>--not just the portion specified in the <command tag="find">find</command> <glossary tag="command">command</glossary>--is surrounded by a box, and the <b>foundText</b> <glossary tag="return">returns</glossary> the entire <keyword tag="word">word</keyword>.</p><p/><p>The <b>foundText</b> <control_st tag="function">function</control_st> is cleared when the text <keyword tag="selection">selection</keyword> moves into the <function tag="foundField">foundField</function> or when the <glossary tag="current card">current card</glossary> is closed. At the same time, the box the <command tag="find">find</command> <glossary tag="command">command</glossary> draws around the found text disappears. If there is no box, the <b>foundText</b> function <glossary tag="return">returns</glossary> empty.</p><p/><p>To get the location of the text that was found, use the <b>foundChunk</b> <control_st tag="function">function</control_st>.</p>

</description>

</doc>