Softanza
StartFrançais
Softanza
StartFrançais
Reference · stzNumber

ApplyFormat()

Apply the default number format (mutating).

Basic examples (2)

Softanza
# five digits
? (new stzNumber(12590)).ApplyFormatXT([ :ThousandsSeparator = "." ])
# seven digits
? (new stzNumber(1234567)).ApplyFormatXT([ :ThousandsSeparator = "," ])
# ten digits
? (new stzNumber(1234567890)).ApplyFormatXT([ :ThousandsSeparator = " " ])
# a number below a thousand needs no separator
? (new stzNumber(590)).ApplyFormatXT([ :ThousandsSeparator = "," ])
cW = (new stzNumber(12590)).ApplyFormatXT([ :Width = 15, :AlignTo = :Center, :ThousandsSeparator = "." ])
# asking for width 15 does not pad (yet)
? len(cW)
Output
+12.590
+1,234,567
+1 234 567 890
+590
7

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

Softanza
oN = new stzNumber(14)
# a number divides
? oN.IsDividableBy(2)
# ...a number in a string too
? oN.IsDividableBy("2")
# ...and one written with decimals
? oN.IsDividableBy("2.00")
# ...while a non-divisor says no
? oN.IsDividableBy("2.001")
cPos = (new stzNumber(1200)).ApplyFormatXT([
		:PutNegativeBetweenParentheses = TRUE, :ShowSign = TRUE ])
# a POSITIVE number gets no stray closing parenthesis
? StzFindFirst(")", cPos)
cNeg = (new stzNumber(-1200)).ApplyFormatXT([
		:PutNegativeBetweenParentheses = TRUE ])
# ...while a negative one is bracketed on both sides
? StzFindFirst("(", cNeg) > 0 and StzFindFirst(")", cNeg) > 0
# the thousands separator now groups in threes
? (new stzNumber(12590)).ApplyFormatXT([ :ThousandsSeparator = "." ])
Output
1
1
1
0
0
1
+12.590

run on 2026-10-02 04:23 inside the library at commit 0e72e2e2c; taken from number_dead_calls_narrated.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
no
takes a case-sensitivity flag
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 · ApplyFormatXT
XTT
no
yet another extension: a further extended form, after XT
Z
no
includes the position in what it returns
ZZ
no
returns positions as sections, [start, end]
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
no
works on a collection of items instead of one (the plural form)
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