Softanza
StartFrançais
Softanza
StartFrançais
Reference · stzString

VizFind()

VizFind / VizFindCSXT / VizFindXT -- visualization (returns a rendered string showing match positions). Provisional: just return the content with matched chars highlighted via ASCII.

Basic examples (2)

Softanza
# four carets on the rail
? StzStringQ("ABTCADNBBABEFACCC").VizFind("A")
Output
ABTCADNBBABEFACCC
^---^----^---^---

run on 2026-10-02 04:24 inside the library at commit 0e72e2e2c; taken from 900_vizfind.ring(opens in a new tab)

Softanza
o1 = new stzString("..STZ..StZ..stz")
# all three marked
? o1.vizFindCS("stz", FALSE)
Output
..STZ..StZ..stz
--^----^----^--

run on 2026-10-02 04:24 inside the library at commit 0e72e2e2c; taken from 953_vizfindcs.ring(opens in a new tab)

Scope (1)

Softanza
o1 = new stzString("..STZ..StZ..stz")
cExp = "..STZ..StZ..stz" + NL +
"--^----^----^--" + NL +
"  3    8    13 "
# VizFindXT with :CS in the options
? o1.VizFindXT("stz", [ :Numbered = TRUE, :CS = FALSE ])
# VizFindCSXT with the dial as its own param
? o1.VizFindCSXT("stz", :CS = FALSE, [ :Numbered = TRUE ])
# ... and the uppercase needle finds the same
? o1.VizFindCSXT("STZ", :CS = FALSE, [ :Numbered = TRUE ])
Output
..STZ..StZ..stz
--^----^----^--
  3    8    13 
..STZ..StZ..stz
--^----^----^--
  3    8    13 
..STZ..StZ..stz
--^----^----^--
  3    8    13

run on 2026-10-02 04:24 inside the library at commit 0e72e2e2c; taken from 954_vizfindcsxt.ring(opens in a new tab)

The extensions of this method

Each extension, and whether it exists for this method; an extension that exists combines with the others (FindSTCS).

Extension
Exists
What it adds · The names
Q
no
does what the method does, then returns the object, so the call can be chained
QQ
no
chains on the next, more specific type of object (the Q ladder)
QQQ
no
chains on the most specific type of object (the Q ladder)
QRT
no
returns the result as an object of the requested type
CS
yes
takes a case-sensitivity flag · VizFindCS, VizFindCSXT
ST
no
takes the position to start from (StartingAt)
IB
no
takes bounds that are included (IncludingBounds)
XT
yes
the extended form: more parameters than the base method · VizFindXT, VizFindCSXT, VizFindManyXT
XTT
no
yet another extension: a further extended form, after XT
Z
no
includes the position in what it returns
ZZ
yes
returns positions as sections, [start, end] · VizFindZZ
W
no
selects by a condition
WF
no
selects by a condition, with the expressive keywords (@NextItem, @PreviousItem...)
D
no
takes a direction, forward or backward (Directional)
F
no
takes a function (the condition or the update is given as a function); the forms document also uses F for the future form, which defers the action
Many
yes
works on a collection of items instead of one (the plural form) · VizFindMany, VizFindManyXT
Except
no
takes exceptions, what to leave out (the exceptional form)
U
no
returns the result without duplication

Every example is a test file of the library, run inside the library for this page; only those whose output kept every promise their file wrote are shown.

See also