Differences

This shows you the differences between two versions of the page.

--- syntax:functions:replace [2015/04/03 18:33] – elenap
+++ syntax:functions:replace [2021/09/08 14:19] (current) – [Remarks] craigt
@@ Line 1: / Line 1: @@
-===== Replace(text, old_string, new_string) =====
+======Replace(text, old_text, new_text) ======
+Category:  Text function
-Replaces all entries of the //old_string// in the //text// with the //new_string//.
+\\
+=====Description=====
+This function replaces all instances of //old_text// with //new_text// within //text//.
-All arguments are implicitly converted into text, if required.
+\\
+=====Arguments=====
+^Argument^Type^Description^
+|text|Text|Any text value or value that can be implicitly converted to text.|
+|old_text|Text|The text  to be found within //text// and replaced by //new_text//, if found.|
+|new_text|Text|The text that replaces //old_text// if found within //text//.|
-^  Example  ^  Result  ^
+**Return value type:** Text
-|  replace('Food & Beverage', '&', 'and')   |  Food and Beverage  |
-|  replace('New York City', 'York City', 'Orleans')  |  New Orleans  |
+\\
+=====Remarks=====
+This function is case sensitive.
+Entering '' (two single quotes; an empty string) as the //new_text// value has the same effect as using the [[syntax:functions:removetext|RemoveText]] function.
+Number values entered for //text//, //old_text//, and //new_text// are implicitly converted to text.
+\\
+=====Examples=====
+  replace('Food & Beverage', '&', 'and') //Returns 'Food and Beverage'
+  replace('New York', 'york', 'Orleans') //Returns 'New York' ('york' isn't found due to the case of 'y'.)
+  replace('New Mexico', ' ', '_') //Returns 'New_Mexico' (Replaces spaces with underscores.)
+  replace(123456789, 456, 654) //Returns '123654789' (Number implicitly converted; return value is text.)
+  replace(190091, "00", 5) //Returns '19591' (Enter multiple zeroes as text; return value is text.)
+\\
+=====See also=====
+  * [[syntax:functions:regexreplace|RegExReplace(text, replace_text, regex_text)]]
+  * [[syntax:functions:removetext|RemoveText(text, string)]]