Changes between Version 7 and Version 8 of ReferenceMaterials/EventApi

Timestamp:

01/24/10 14:39:14 (16 years ago)

Author:

DanWilson (IP: 65.190.16.149)

Comment:

added copytoscope doclet

ReferenceMaterials/EventApi

@@ -48 +48 @@
 
 Name (required) - The name of the argument to check
+
+== !CopyToScope(scope:struct, listOfEventKeys:string [,arrayOfDefaults:array]) ==
+
+==== Description: ====
+
+Populates the scope with event values matched in the listOfEventKeys, and uses an optional array to set default values according to position. This method can replace many Event.getValue() statements with a single line of code.
+
+
+==== Returns: ====
+
+Void
+
+==== Arguments: ====
+
+Scope: (required) - A struct or component instance to be populated.
+
+ListOfEventKeys: (required) - a comma delimited list of keys to look for in the event. Any key not found will be defaulted with an empty string, or if the arrayOfDefaults was passed, the value of the array position matching the position of the current list item.
+
+ArrayOfDefaults: (optional) - An array of values used as defaults. The first position in the array is the default for the first position in the listOfEventKeys list. This array does not have to have the same length as the listOfEventKeys and if no array item is found the empty string will be used as the default.
+
+==== Example: ====
+
+{{{
+<!-- Someview.cfm --->
+
+<cfset defaultArray = ["DefaultForFoot", "DefaultForHand"] />
+<cfset event.copyToScope(variables, "foot,hand,xe.nested", defaultArray) />
+
+<!--- the variables scope now contains foot:DefaultForFoot, hand:DefaultForHand, xe.nested:"" --->
+}}}
 
 == Forward(eventhandler:string [, append:list]) ==
@@ -133 +163 @@
 }}}
 
+
+
 == !GetValue(name:string [, default:any]) ==