CFLib.org – Common Function Library Project

MessageListDisplay(emData[, beginString][, endString])

Last updated May 2, 2002

author

Will Vautrain

Version: 1 | Requires: CF5 | Library: StrLib

Description:
It takes in an array or struct of basic values, and returns each element with user-specified or default HTML tags wrapped around it. It is useful when accumulating error messages inside an array or struct during data validation and exception catching. Then you can just call MessageListDisplay when you're ready to display the output.

Return Values:
Returns a string.

Example:

<cfset em = ArrayNew(1)>
<cfset ArrayAppend(em, "Job number must be a six-digit number.")>
<cfset ArrayAppend(em, "You did not specify a valid user ID.")>
<cfset ArrayAppend(em, "You can display error messages in blue text.")>

<cfoutput>
#MessageListDisplay(em, "<p style=""color : blue;"">", "</p>")#
</cfoutput>

Parameters:

Name Description Required
emData Struct or array of strings. Yes
beginString String to place before each stirng in emData. No
endString String to place after each stirng in emData. No

Full UDF Source:

/**
 * Takes an array or struct of basic values and returns and HTML-formatted string.
 * 
 * @param emData 	 Struct or array of strings. (Required)
 * @param beginString 	 String to place before each stirng in emData. (Optional)
 * @param endString 	 String to place after each stirng in emData. (Optional)
 * @return Returns a string. 
 * @author Will Vautrain (vautrain@yahoo.com) 
 * @version 1, May 2, 2002 
 */
function MessageListDisplay(emData) {
	
	var returnStr = "";
	var beginStr = "<p style=""color : red;"">";
	var endStr = "</p>";
	var s = ArrayNew(1);
	var i = 1;
	
	if (ArrayLen(Arguments) gt 1) {
	
		beginStr = Arguments[2];	
	}
	
	if (ArrayLen(Arguments) gt 2) {
	
		endStr = Arguments[3];	
	}
	
	if (IsArray(emData) and not ArrayIsEmpty(emData)) {

		i = 1;
		while (i lte ArrayLen(emData)) {
			returnStr = returnStr & beginStr & emData[i] & endStr;
			i = i + 1;
			
		}
	} 
	
	if (IsStruct(emData) and not StructIsEmpty(emData)) {

		s = StructKeyArray(emData);
		i = 1;
		while (i lte ArrayLen(s)) {
			returnStr = returnStr & beginStr & StructFind(emData, s[i]) & endStr;
			i = i + 1;
		}
	}
	
	return returnStr;
}
blog comments powered by Disqus

Search CFLib.org


Latest Additions

Kevin Cotton added
date2ExcelDate
May 5, 2016

Raymond Camden added
CapFirst
April 25, 2016

Chris Wigginton added
loremIpsum
January 18, 2016

Gary Stanton added
calculateArrival...
November 19, 2015

Sebastiaan Naafs - van Dijk added
getDaysInQuarter
November 13, 2015

Created by Raymond Camden / Design by Justin Johnson