Differences

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

--- syntax:functions:removetext [2016/06/20 11:38] – dmitry
+++ syntax:functions:removetext [2021/08/15 02:49] – craigt
@@ Line 1: / Line 1: @@
-===== RemoveText(text, string) =====
+======RemoveText(text, string) ======
+Category:  Text function
-Removes all occurrences of //string// from //text//.
+\\
+=====Description=====
+This function removes all instances of //string// from //text//.
-^  Example  ^  Result  ^
+\\
-| removetext('Miss Mississippi', 'iss')  | M Mippi  |
+=====Arguments=====
+^Argument^Type^Description^
+|text|Text|Any text value from which the text //string// is removed.|
+|string|Text|The text string removed from //text//.|
+**Return value type:** Text
+\\
+=====Remarks=====
+This function is case sensitive.
+Number values entered for //text// and //string// are implicitly converted to text.
+All instances of //string// are removed from //text//.
+If //string// is not found within //text//, the full value of //text// is returned.
+\\
+=====Examples=====
+  removetext('Miss Mississippi', 'iss') //Returns 'M Mippi'
+  removetext('Wellington', 'well') //Returns 'Wellington'  ('well' not found due to case; text value is returned)
+  removestart(123456123, 123) //Returns '456' (Numbers implicitly converted to text; return value is text)
+\\
+=====See also=====
+  * [[syntax:functions:remove|Remove(text, start, length)]]
+  * [[syntax:functions:removechars|RemoveChars(text, string)]]
+  * [[syntax:functions:removeend|RemoveEnd(text, length)]]
+  * [[syntax:functions:removestart|RemoveStart(text, length)]]
-=== See also ===
-  * [[syntax:functions:keepchars]]
-  * [[syntax:functions:removechars]]
-  * [[syntax:functions:remove]]