ReplaceList

Description

Replaces occurrences of the elements from a delimited list in a string with corresponding elements from another delimited list. The search is case-sensitive.

Return value

A copy of the string, after making replacements.

Syntax

ReplaceList(string, list1, list2)

Parameters

Parameter Description

string
A string, or a variable that contains one, within which to replace substring

list1
Comma-delimited list of substrings for which to search

list2
Comma-delimited list of replacement substrings

Parameter	Description
string	A string, or a variable that contains one, within which to replace substring
list1	Comma-delimited list of substrings for which to search
list2	Comma-delimited list of replacement substrings

Usage

The list of substrings to replace is processed sequentially. If a list1 element is contained in list2 elements, recursive replacement might occur. The second example shows this.

Example

<p>The Replacelist function returns <I>string</I> with 
<I>substringlist1</I> (e.g. "a,b") replaced by <I>substringlist2</I> 
(e.g. "c,d") in the specified scope.
<cfif IsDefined("FORM.MyString")>
<p>Your original string, <cfoutput>#FORM.MyString#</cfoutput>
<p>You wanted to replace the substring <cfoutput>#FORM.MySubstring1#
 </cfoutput>
with the substring <cfoutput>#FORM.MySubstring2#</cfoutput>.
<p>The result: <cfoutput>#Replacelist(FORM.myString,
FORM.MySubstring1, FORM.mySubString2)#</cfoutput>
</cfif>
<form action = "replacelist.cfm" method="post">
<p>String 1
<br><input type = "Text" value = "My Test String" name = "MyString">
<p>Substring 1 (find this list of substrings)
<br><input type = "Text" value = "Test, String" name = "MySubstring1">
<p>Substring 2 (replace with this list of substrings)
<br><input type = "Text" value = "Replaced, Sentence" name = "MySubstring2">
<p><input type = "Submit" value = "Replace and display" name = ""> 
</form>

<h3>Replacelist Example Two</h3>
<cfset stringtoreplace = "The quick brown fox jumped over the lazy dog.">
<cfoutput>
  #replacelist(stringtoreplace,"dog,brown,fox,black", "cow,black,ferret,white")#
</cfoutput>

Version 6

Comments are no longer accepted for ColdFusion MX. ColdFusion 8 is the current version.

Comments

glenn.wilson@quotege said on Oct 1, 2002 at 3:24 PM :

I'm assuming that this function works for the scope ALL?

No screen name said on Sep 4, 2003 at 11:18 AM :

This does work with the all. Advantages to this method vs a looped replace are that it looks for the words specifically regardless of punctuation, etc. Disadvantages are that does not distinguish between whole words or partial words. For instance, looking for "hop" and replaceing it with "jump" would replace the following (hop, hopping, hope) with (jump, jumpping, jumpe), so you need to consider that in using it. Better to loop through REReplace or REReplaceNoCase with regular expressions.

RSS feed | Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/coldfusion/6/CFML_Reference/functions-pt267.htm