forked from livecode/livecode
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfoundLoc.xml
More file actions
47 lines (47 loc) · 2.69 KB
/
Copy pathfoundLoc.xml
File metadata and controls
47 lines (47 loc) · 2.69 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
<doc>
<legacy_id>1730</legacy_id>
<name>foundLoc</name>
<type>function</type>
<syntax>
<example>the foundLoc</example>
<example>foundLoc()</example>
</syntax>
<library></library>
<objects>
</objects>
<synonyms>
</synonyms>
<classification>
<category>Database Operations</category>
</classification>
<references>
<command tag="find">find Command</command>
<function tag="selectedLoc">selectedLoc 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 location of the top left corner of the box that surrounds text found by the <command tag="find">find</command> <glossary tag="command">command</glossary>.</summary>
<examples>
<example>the foundLoc</example>
<example>drag from the foundLoc to the bottomLeft of this card</example>
</examples>
<description>
<p>Use the <b>foundLoc</b> <control_st tag="function">function</control_st> to determine the location in the <glossary tag="stack window">stack window</glossary> where the found text is shown.</p><p/><p><b>Value:</b></p><p>The <b>foundLoc</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> two positive <glossary tag="integer">integers</glossary> separated by a comma.</p><p/><p><b>Comments:</b></p><p>When the <b>find</b> command finds text, it surrounds the text with a box. The first <keyword tag="item">item</keyword> of the <glossary tag="return value">return value</glossary> is the horizontal distance in <property tag="pixels">pixels</property> from the left edge of the <object tag="stack">stack</object> to the left edge of this box. The second <keyword tag="item">item</keyword> of the <glossary tag="return value">returned value</glossary> is the vertical distance from the top edge of the <glossary tag="stack window">stack window</glossary> to the top of the box.</p><p/><p>The <b>foundLoc</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>foundLoc</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> empty.</p>
</description>
</doc>