This repository was archived by the owner on Aug 31, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 226
Expand file tree
/
Copy pathfoundChunk.lcdoc
More file actions
51 lines (34 loc) · 1.49 KB
/
foundChunk.lcdoc
File metadata and controls
51 lines (34 loc) · 1.49 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
48
49
50
Name: foundChunk
Type: function
Syntax: the foundChunk
Syntax: foundChunk()
Summary:
<return|Returns> a <chunk expression> describing the location of the
text that was found by the most recent <find> <command>.
Introduced: 1.0
OS: mac, windows, linux, ios, android
Platforms: desktop, server, mobile
Example:
the foundChunk
Example:
if the foundChunk is not word 1 of thingToFind then find thingToFind
Returns:
The <foundChunk> <function> <return|returns> a <chunk expression> of the
form char startChar to endChar of field fieldNumber.
Description:
Use the <foundChunk> function after a <find> <command> to determine
where the text was found.
The <foundChunk> <function> is cleared when the text <selection> moves
into the <foundField> or when the <current card> is closed. At the same
time, the box the <find> command draws around the found text disappears.
If there is no box, the <foundChunk> function <return|returns> empty.
The return value reports the text that was found: the startChar is the
first <character> of the found text, and the endChar is the last
<character>. For example, if the most recent <find> <command> was find
"foo bar", either word might have been found.
To get the actual text that was found, use the foundText <function>.
References: find (command), function (control structure),
selectedChunk (function), foundField (function), current card (glossary),
command (glossary), return (glossary), chunk expression (glossary),
selection (keyword), character (keyword)
Tags: database