CFWheels.xml

<?xml version="1.0" encoding="UTF-8"?>
<d:dictionary xmlns="http://www.w3.org/1999/xhtml" xmlns:d="http://www.apple.com/DTDs/DictionaryService-1.0.rng">

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->

	<d:entry id="cfwheels_application" d:title="CFWheels">
		<d:index d:value="CFWheels"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<p>CFWheels (ColdFusion on Wheels) is an open-source ColdFusion (CFML) framework inspired by Ruby on Rails.</p>
	
		<p>
			It provides fast application development, a great organization system for code, and is just plain fun to use.
		</p>
	
		<p>
			Start by looking at the <a href="x-dictionary:d:API:cfwheels_application">CFWheels API</a>.
		</p>

		<p>
			To find out more, go to http://cfwheels.org/
		</p>
		
	
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="cfwheels_api" d:title="API" d:parental-control="1">
		<d:index d:value="API"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1>CFWheels API - List of Functions (A-Z)</h1>

		<div d:parental-control="1" d:priority="2">
			<ul>
				<li><a href="x-dictionary:d:accessibleProperties():cfwheels_application">accessibleProperties()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:addDefaultRoutes():cfwheels_application">addDefaultRoutes()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:addError():cfwheels_application">addError()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:addErrorToBase():cfwheels_application">addErrorToBase()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:addFormat():cfwheels_application">addFormat()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:addRoute():cfwheels_application">addRoute()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:afterCreate():cfwheels_application">afterCreate()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:afterDelete():cfwheels_application">afterDelete()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:afterFind():cfwheels_application">afterFind()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:afterInitialization():cfwheels_application">afterInitialization()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:afterNew():cfwheels_application">afterNew()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:afterSave():cfwheels_application">afterSave()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:afterUpdate():cfwheels_application">afterUpdate()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:afterValidation():cfwheels_application">afterValidation()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:afterValidationOnCreate():cfwheels_application">afterValidationOnCreate()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:afterValidationOnUpdate():cfwheels_application">afterValidationOnUpdate()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:allChanges():cfwheels_application">allChanges()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:allErrors():cfwheels_application">allErrors()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:autoLink():cfwheels_application">autoLink()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:automaticValidations():cfwheels_application">automaticValidations()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:average():cfwheels_application">average()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:beforeCreate():cfwheels_application">beforeCreate()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:beforeDelete():cfwheels_application">beforeDelete()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:beforeSave():cfwheels_application">beforeSave()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:beforeUpdate():cfwheels_application">beforeUpdate()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:beforeValidation():cfwheels_application">beforeValidation()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:beforeValidationOnCreate():cfwheels_application">beforeValidationOnCreate()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:beforeValidationOnUpdate():cfwheels_application">beforeValidationOnUpdate()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:belongsTo():cfwheels_application">belongsTo()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:buttonTag():cfwheels_application">buttonTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:buttonTo():cfwheels_application">buttonTo()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:caches():cfwheels_application">caches()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:capitalize():cfwheels_application">capitalize()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:changedFrom():cfwheels_application">changedFrom()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:changedProperties():cfwheels_application">changedProperties()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:checkBox():cfwheels_application">checkBox()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:checkBoxTag():cfwheels_application">checkBoxTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:clearErrors():cfwheels_application">clearErrors()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:columnDataForProperty():cfwheels_application">columnDataForProperty()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:columnForProperty():cfwheels_application">columnForProperty()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:columnNames():cfwheels_application">columnNames()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:columns():cfwheels_application">columns()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:compareTo():cfwheels_application">compareTo()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:contentFor():cfwheels_application">contentFor()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:contentForLayout():cfwheels_application">contentForLayout()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:controller():cfwheels_application">controller()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:count():cfwheels_application">count()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:create():cfwheels_application">create()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:cycle():cfwheels_application">cycle()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:dataSource():cfwheels_application">dataSource()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:dateSelect():cfwheels_application">dateSelect()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:dateSelectTags():cfwheels_application">dateSelectTags()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:dateTimeSelect():cfwheels_application">dateTimeSelect()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:dateTimeSelectTags():cfwheels_application">dateTimeSelectTags()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:daySelectTag():cfwheels_application">daySelectTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:delete():cfwheels_application">delete()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:deleteAll():cfwheels_application">deleteAll()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:deleteByKey():cfwheels_application">deleteByKey()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:deleteOne():cfwheels_application">deleteOne()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:deobfuscateParam():cfwheels_application">deobfuscateParam()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:distanceOfTimeInWords():cfwheels_application">distanceOfTimeInWords()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:endFormTag():cfwheels_application">endFormTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:errorCount():cfwheels_application">errorCount()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:errorMessageOn():cfwheels_application">errorMessageOn()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:errorMessagesFor():cfwheels_application">errorMessagesFor()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:errorsOn():cfwheels_application">errorsOn()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:errorsOnBase():cfwheels_application">errorsOnBase()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:excerpt():cfwheels_application">excerpt()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:exists():cfwheels_application">exists()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:fileField():cfwheels_application">fileField()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:fileFieldTag():cfwheels_application">fileFieldTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:filterChain():cfwheels_application">filterChain()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:filters():cfwheels_application">filters()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:findAll():cfwheels_application">findAll()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:findByKey():cfwheels_application">findByKey()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:findOne():cfwheels_application">findOne()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:flash():cfwheels_application">flash()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:flashClear():cfwheels_application">flashClear()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:flashCount():cfwheels_application">flashCount()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:flashDelete():cfwheels_application">flashDelete()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:flashInsert():cfwheels_application">flashInsert()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:flashIsEmpty():cfwheels_application">flashIsEmpty()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:flashKeep():cfwheels_application">flashKeep()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:flashKeyExists():cfwheels_application">flashKeyExists()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:flashMessages():cfwheels_application">flashMessages()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:get():cfwheels_application">get()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:getTableNamePrefix():cfwheels_application">getTableNamePrefix()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:hasChanged():cfwheels_application">hasChanged()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:hasErrors():cfwheels_application">hasErrors()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:hasMany():cfwheels_application">hasMany()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:hasManyCheckBox():cfwheels_application">hasManyCheckBox()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:hasManyRadioButton():cfwheels_application">hasManyRadioButton()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:hasOne():cfwheels_application">hasOne()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:hasProperty():cfwheels_application">hasProperty()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:hiddenField():cfwheels_application">hiddenField()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:hiddenFieldTag():cfwheels_application">hiddenFieldTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:highlight():cfwheels_application">highlight()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:hourSelectTag():cfwheels_application">hourSelectTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:humanize():cfwheels_application">humanize()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:hyphenize():cfwheels_application">hyphenize()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:imageTag():cfwheels_application">imageTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:includeContent():cfwheels_application">includeContent()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:includedInObject():cfwheels_application">includedInObject()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:includeLayout():cfwheels_application">includeLayout()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:includePartial():cfwheels_application">includePartial()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:invokeWithTransaction():cfwheels_application">invokeWithTransaction()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:isAjax():cfwheels_application">isAjax()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:isClass():cfwheels_application">isClass()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:isGet():cfwheels_application">isGet()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:isInstance():cfwheels_application">isInstance()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:isNew():cfwheels_application">isNew()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:isPost():cfwheels_application">isPost()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:isSecure():cfwheels_application">isSecure()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:javaScriptIncludeTag():cfwheels_application">javaScriptIncludeTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:key():cfwheels_application">key()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:linkTo():cfwheels_application">linkTo()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:mailTo():cfwheels_application">mailTo()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:maximum():cfwheels_application">maximum()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:mimeTypes():cfwheels_application">mimeTypes()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:minimum():cfwheels_application">minimum()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:minuteSelectTag():cfwheels_application">minuteSelectTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:model():cfwheels_application">model()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:monthSelectTag():cfwheels_application">monthSelectTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:nestedProperties():cfwheels_application">nestedProperties()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:new():cfwheels_application">new()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:obfuscateParam():cfwheels_application">obfuscateParam()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:onlyProvides():cfwheels_application">onlyProvides()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:pagination():cfwheels_application">pagination()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:paginationLinks():cfwheels_application">paginationLinks()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:passwordField():cfwheels_application">passwordField()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:passwordFieldTag():cfwheels_application">passwordFieldTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:pluginNames():cfwheels_application">pluginNames()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:pluralize():cfwheels_application">pluralize()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:primaryKey():cfwheels_application">primaryKey()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:primaryKeys():cfwheels_application">primaryKeys()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:properties():cfwheels_application">properties()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:property():cfwheels_application">property()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:propertyIsPresent():cfwheels_application">propertyIsPresent()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:propertyNames():cfwheels_application">propertyNames()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:protectedProperties():cfwheels_application">protectedProperties()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:provides():cfwheels_application">provides()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:radioButton():cfwheels_application">radioButton()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:radioButtonTag():cfwheels_application">radioButtonTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:redirectTo():cfwheels_application">redirectTo()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:reload():cfwheels_application">reload()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:renderNothing():cfwheels_application">renderNothing()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:renderPage():cfwheels_application">renderPage()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:renderPartial():cfwheels_application">renderPartial()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:renderText():cfwheels_application">renderText()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:renderWith():cfwheels_application">renderWith()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:resetCycle():cfwheels_application">resetCycle()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:response():cfwheels_application">response()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:save():cfwheels_application">save()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:secondSelectTag():cfwheels_application">secondSelectTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:select():cfwheels_application">select()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:selectTag():cfwheels_application">selectTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:sendEmail():cfwheels_application">sendEmail()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:sendFile():cfwheels_application">sendFile()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:set():cfwheels_application">set()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:setFilterChain():cfwheels_application">setFilterChain()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:setPagination():cfwheels_application">setPagination()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:setPrimaryKey():cfwheels_application">setPrimaryKey()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:setPrimaryKeys():cfwheels_application">setPrimaryKeys()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:setProperties():cfwheels_application">setProperties()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:setResponse():cfwheels_application">setResponse()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:setTableNamePrefix():cfwheels_application">setTableNamePrefix()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:setVerificationChain():cfwheels_application">setVerificationChain()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:simpleFormat():cfwheels_application">simpleFormat()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:singularize():cfwheels_application">singularize()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:startFormTag():cfwheels_application">startFormTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:stripLinks():cfwheels_application">stripLinks()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:stripTags():cfwheels_application">stripTags()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:styleSheetLinkTag():cfwheels_application">styleSheetLinkTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:submitTag():cfwheels_application">submitTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:sum():cfwheels_application">sum()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:table():cfwheels_application">table()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:tableName():cfwheels_application">tableName()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:textArea():cfwheels_application">textArea()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:textAreaTag():cfwheels_application">textAreaTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:textField():cfwheels_application">textField()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:textFieldTag():cfwheels_application">textFieldTag()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:timeAgoInWords():cfwheels_application">timeAgoInWords()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:timeSelect():cfwheels_application">timeSelect()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:timeSelectTags():cfwheels_application">timeSelectTags()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:timeUntilInWords():cfwheels_application">timeUntilInWords()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:titleize():cfwheels_application">titleize()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:toggle():cfwheels_application">toggle()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:toXHTML():cfwheels_application">toXHTML()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:truncate():cfwheels_application">truncate()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:update():cfwheels_application">update()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:updateAll():cfwheels_application">updateAll()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:updateByKey():cfwheels_application">updateByKey()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:updateOne():cfwheels_application">updateOne()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:updateProperties():cfwheels_application">updateProperties()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:updateProperty():cfwheels_application">updateProperty()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:URLFor():cfwheels_application">URLFor()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:usesLayout():cfwheels_application">usesLayout()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:valid():cfwheels_application">valid()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:validate():cfwheels_application">validate()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:validateOnCreate():cfwheels_application">validateOnCreate()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:validateOnUpdate():cfwheels_application">validateOnUpdate()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:validatesConfirmationOf():cfwheels_application">validatesConfirmationOf()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:validatesExclusionOf():cfwheels_application">validatesExclusionOf()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:validatesFormatOf():cfwheels_application">validatesFormatOf()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:validatesInclusionOf():cfwheels_application">validatesInclusionOf()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:validatesLengthOf():cfwheels_application">validatesLengthOf()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:validatesNumericalityOf():cfwheels_application">validatesNumericalityOf()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:validatesPresenceOf():cfwheels_application">validatesPresenceOf()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:validatesUniquenessOf():cfwheels_application">validatesUniquenessOf()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:verificationChain():cfwheels_application">verificationChain()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:verifies():cfwheels_application">verifies()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:wordTruncate():cfwheels_application">wordTruncate()</a></li>
			</ul>
			<ul>
				<li><a href="x-dictionary:d:yearSelectTag():cfwheels_application">yearSelectTag()</a></li>
			</ul>
		</div>
	
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="accessibleproperties" d:title="accessibleProperties" d:parental-control="1">
		<d:index d:value="accessibleProperties"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>accessibleProperties()</code></h1>
	
		<h2>Description</h2>
		<p>Use this method to specify which properties can be set through mass assignment.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">accessibleProperties([ <em>properties</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Property name (or list of property names) that are allowed to be altered through mass assignment.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In `models/User.cfc`, only `isActive` can be set through mass assignment operations like `updateAll()` ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;cfset accessibleProperties(&quot;isActive&quot;)&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="adddefaultroutes" d:title="addDefaultRoutes" d:parental-control="1">
		<d:index d:value="addDefaultRoutes"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>addDefaultRoutes()</code></h1>
	
		<h2>Description</h2>
		<p>Adds the default Wheels routes (for example, `[controller]/[action]/[key]`, etc.) to your application. Only use this method if you have set `loadDefaultRoutes` to `false` and want to control exactly where in the route order you want to place the default routes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">addDefaultRoutes()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Adds the default routes to your application (done in `config/routes.cfm`) ---&gt;
&lt;cfset addDefaultRoutes()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="adderror" d:title="addError" d:parental-control="1">
		<d:index d:value="addError"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>addError()</code></h1>
	
		<h2>Description</h2>
		<p>Adds an error on a specific property.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">addError(<em>property</em>, <em>message</em> [, <em>name</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the property you want to add an error on.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>message</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The error message (such as &quot;Please enter a correct name in the form field&quot; for example).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">A name to identify the error by (useful when you need to distinguish one error from another one set on the same object and you don't want to use the error message itself for that).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Add an error to the `email` property ---&gt;
&lt;cfset this.addError(property=&quot;email&quot;, message=&quot;Sorry, you are not allowed to use that email. Try again, please.&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="adderrortobase" d:title="addErrorToBase" d:parental-control="1">
		<d:index d:value="addErrorToBase"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>addErrorToBase()</code></h1>
	
		<h2>Description</h2>
		<p>Adds an error on the object as a whole (not related to any specific property).</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">addErrorToBase(<em>message</em> [, <em>name</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>message</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The error message (such as &quot;Please enter a correct name in the form field&quot; for example).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">A name to identify the error by (useful when you need to distinguish one error from another one set on the same object and you don't want to use the error message itself for that).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Add an error on the object ---&gt;
&lt;cfset this.addErrorToBase(message=&quot;Your email address must be the same as your domain name.&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="addformat" d:title="addFormat" d:parental-control="1">
		<d:index d:value="addFormat"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>addFormat()</code></h1>
	
		<h2>Description</h2>
		<p>Adds a new MIME format to your Wheels application for use with responding to multiple formats.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">addFormat(<em>extension</em>, <em>mimeType</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>extension</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">File extension to add.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>mimeType</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Matching MIME type to associate with the file extension.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Add the `js` format ---&gt;
&lt;cfset addFormat(extension=&quot;js&quot;, mimeType=&quot;text/javascript&quot;)&gt;

&lt;!--- Add the `ppt` and `pptx` formats ---&gt;
&lt;cfset addFormat(extension=&quot;ppt&quot;, mimeType=&quot;application/vnd.ms-powerpoint&quot;)&gt;
&lt;cfset addFormat(extension=&quot;pptx&quot;, mimeType=&quot;application/vnd.ms-powerpoint&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="addroute" d:title="addRoute" d:parental-control="1">
		<d:index d:value="addRoute"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>addRoute()</code></h1>
	
		<h2>Description</h2>
		<p>Adds a new route to your application.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">addRoute(<em>pattern</em> [, <em>name</em>, <em>controller</em>, <em>action</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name for the route. This is referenced as the `name` argument in functions based on @URLFor like @linkTo, @startFormTag, etc.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>pattern</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The URL pattern that the route will match.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>controller</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Controller to call when route matches (unless the controller name exists in the pattern).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>action</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Action to call when route matches (unless the action name exists in the pattern).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Example 1: Adds a route which will invoke the `profile` action on the `user` controller with `params.userName` set when the URL matches the `pattern` argument ---&gt;
&lt;cfset addRoute(name=&quot;userProfile&quot;, pattern=&quot;user/[username]&quot;, controller=&quot;user&quot;, action=&quot;profile&quot;)&gt;

&lt;!--- Example 2: Category/product URLs. Note the order of precedence is such that the more specific route should be defined first so Wheels will fall back to the less-specific version if it's not found ---&gt;
&lt;cfset addRoute(name=&quot;product&quot;, pattern=&quot;products/[categorySlug]/[productSlug]&quot;, controller=&quot;products&quot;, action=&quot;product&quot;)&gt;
&lt;cfset addRoute(name=&quot;productCategory&quot;, pattern=&quot;products/[categorySlug]&quot;, controller=&quot;products&quot;, action=&quot;category&quot;)&gt;
&lt;cfset addRoute(name=&quot;products&quot;, pattern=&quot;products&quot;, controller=&quot;products&quot;, action=&quot;index&quot;)&gt;

&lt;!--- Example 3: Change the `home` route. This should be listed last because it is least specific ---&gt;
&lt;cfset addRoute(name=&quot;home&quot;, pattern=&quot;&quot;, controller=&quot;main&quot;, action=&quot;index&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="aftercreate" d:title="afterCreate" d:parental-control="1">
		<d:index d:value="afterCreate"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>afterCreate()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called after a new object is created.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">afterCreate([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `fixObj` method ---&gt;
&lt;cfset afterCreate(&quot;fixObj&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="afterdelete" d:title="afterDelete" d:parental-control="1">
		<d:index d:value="afterDelete"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>afterDelete()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called after an object is deleted.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">afterDelete([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `fixObj` method ---&gt;
&lt;cfset afterDelete(&quot;fixObj&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="afterfind" d:title="afterFind" d:parental-control="1">
		<d:index d:value="afterFind"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>afterFind()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called after an existing object has been initialized (which is usually done with the @findByKey or @findOne method).</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">afterFind([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `setTime` method after getting objects or records with one of the finder methods ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;cfset afterFind(&quot;setTime&quot;)&gt;
&lt;/cffunction&gt;

&lt;cffunction name=&quot;setTime&quot;&gt;
	&lt;cfset arguments.fetchedAt = Now()&gt;
	&lt;cfreturn arguments&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="afterinitialization" d:title="afterInitialization" d:parental-control="1">
		<d:index d:value="afterInitialization"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>afterInitialization()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called after an object has been initialized.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">afterInitialization([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `fixObj` method ---&gt;
&lt;cfset afterInitialization(&quot;fixObj&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="afternew" d:title="afterNew" d:parental-control="1">
		<d:index d:value="afterNew"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>afterNew()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called after a new object has been initialized (which is usually done with the @new method).</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">afterNew([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `fixObj` method ---&gt;
&lt;cfset afterNew(&quot;fixObj&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="aftersave" d:title="afterSave" d:parental-control="1">
		<d:index d:value="afterSave"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>afterSave()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called after an object is saved.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">afterSave([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `fixObj` method ---&gt;
&lt;cfset afterSave(&quot;fixObj&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="afterupdate" d:title="afterUpdate" d:parental-control="1">
		<d:index d:value="afterUpdate"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>afterUpdate()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called after an existing object is updated.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">afterUpdate([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `fixObj` method ---&gt;
&lt;cfset afterUpdate(&quot;fixObj&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="aftervalidation" d:title="afterValidation" d:parental-control="1">
		<d:index d:value="afterValidation"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>afterValidation()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called after an object is validated.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">afterValidation([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `fixObj` method ---&gt;
&lt;cfset afterValidation(&quot;fixObj&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="aftervalidationoncreate" d:title="afterValidationOnCreate" d:parental-control="1">
		<d:index d:value="afterValidationOnCreate"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>afterValidationOnCreate()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called after a new object is validated.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">afterValidationOnCreate([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `fixObj` method ---&gt;
&lt;cfset afterValidationOnCreate(&quot;fixObj&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="aftervalidationonupdate" d:title="afterValidationOnUpdate" d:parental-control="1">
		<d:index d:value="afterValidationOnUpdate"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>afterValidationOnUpdate()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called after an existing object is validated.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">afterValidationOnUpdate([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `fixObj` method ---&gt;
&lt;cfset afterValidationOnUpdate(&quot;fixObj&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="allchanges" d:title="allChanges" d:parental-control="1">
		<d:index d:value="allChanges"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>allChanges()</code></h1>
	
		<h2>Description</h2>
		<p>Returns a struct detailing all changes that have been made on the object but not yet saved to the database.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">allChanges()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get an object, change it, and then ask for its changes (will return a struct containing the changes, both property names and their values) ---&gt;
&lt;cfset member = model(&quot;member&quot;).findByKey(params.memberId)&gt;
&lt;cfset member.firstName = params.newFirstName&gt;
&lt;cfset member.email = params.newEmail&gt;
&lt;cfset allChanges = member.allChanges()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="allerrors" d:title="allErrors" d:parental-control="1">
		<d:index d:value="allErrors"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>allErrors()</code></h1>
	
		<h2>Description</h2>
		<p>Returns an array of all the errors on the object.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">allErrors()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get all the errors for the `user` object ---&gt;
&lt;cfset errorInfo = user.allErrors()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="autolink" d:title="autoLink" d:parental-control="1">
		<d:index d:value="autoLink"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>autoLink()</code></h1>
	
		<h2>Description</h2>
		<p>Turns all URLs and email addresses into hyperlinks.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">autoLink(<em>text</em> [, <em>link</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>text</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The text to create links in.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>link</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>all</code></td>
				<td valign="top">Whether to link URLs, email addresses or both. Possible values are: `all` (default), `URLs` and `emailAddresses`.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>#autoLink(&quot;Download Wheels from http://cfwheels.org/download&quot;)#
-&gt; Download Wheels from &lt;a href=&quot;http://cfwheels.org/download&quot;&gt;http://cfwheels.org/download&lt;/a&gt;

#autoLink(&quot;Email us at info@cfwheels.org&quot;)#
-&gt; Email us at &lt;a href=&quot;mailto:info@cfwheels.org&quot;&gt;info@cfwheels.org&lt;/a&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="automaticvalidations" d:title="automaticValidations" d:parental-control="1">
		<d:index d:value="automaticValidations"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>automaticValidations()</code></h1>
	
		<h2>Description</h2>
		<p>Whether or not to enable default validations for this model.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">automaticValidations()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In `models/User.cfc`, disable automatic validations. In this case, automatic validations are probably enabled globally, but we want to disable just for this model ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;cfset automaticValidations(false)&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="average" d:title="average" d:parental-control="1">
		<d:index d:value="average"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>average()</code></h1>
	
		<h2>Description</h2>
		<p>Calculates the average value for a given property. Uses the SQL function `AVG`. If no records can be found to perform the calculation on you can use the `ifNull` argument to decide what should be returned.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">average(<em>property</em> [, <em>where</em>, <em>include</em>, <em>distinct</em>, <em>parameterize</em>, <em>ifNull</em>, <em>includeSoftDeletes</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the property to calculate the average for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>where</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `&lt;&gt;`, `&lt;`, `&lt;=`, `&gt;`, `&gt;=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>include</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>distinct</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">When `true`, `AVG` will be performed only on each unique instance of a value, regardless of how many times the value occurs.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>ifNull</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The value returned if no records are found. Common usage is to set this to `0` to make sure a numeric value is always returned instead of a blank string.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>includeSoftDeletes</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">You can set this argument to `true` to include soft-deleted records in the results.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get the average salary for all employees ---&gt;
&lt;cfset avgSalary = model(&quot;employee&quot;).average(&quot;salary&quot;)&gt;

&lt;!--- Get the average salary for employees in a given department ---&gt;
&lt;cfset avgSalary = model(&quot;employee&quot;).average(property=&quot;salary&quot;, where=&quot;departmentId=#params.key#&quot;)&gt;

&lt;!--- Make sure a numeric value is always returned if no records are calculated ---&gt;
&lt;cfset avgSalary = model(&quot;employee&quot;).average(property=&quot;salary&quot;, where=&quot;salary BETWEEN #params.min# AND #params.max#&quot;, ifNull=0&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="beforecreate" d:title="beforeCreate" d:parental-control="1">
		<d:index d:value="beforeCreate"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>beforeCreate()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called before a new object is created.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">beforeCreate([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `fixObj` method ---&gt;
&lt;cfset beforeCreate(&quot;fixObj&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="beforedelete" d:title="beforeDelete" d:parental-control="1">
		<d:index d:value="beforeDelete"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>beforeDelete()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called before an object is deleted.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">beforeDelete([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `fixObj` method ---&gt;
&lt;cfset beforeDelete(&quot;fixObj&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="beforesave" d:title="beforeSave" d:parental-control="1">
		<d:index d:value="beforeSave"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>beforeSave()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called before an object is saved.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">beforeSave([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `fixObj` method ---&gt;
&lt;cfset beforeSave(&quot;fixObj&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="beforeupdate" d:title="beforeUpdate" d:parental-control="1">
		<d:index d:value="beforeUpdate"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>beforeUpdate()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called before an existing object is updated.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">beforeUpdate([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `fixObj` method ---&gt;
&lt;cfset beforeUpdate(&quot;fixObj&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="beforevalidation" d:title="beforeValidation" d:parental-control="1">
		<d:index d:value="beforeValidation"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>beforeValidation()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called before an object is validated.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">beforeValidation([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `fixObj` method ---&gt;
&lt;cfset beforeValidation(&quot;fixObj&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="beforevalidationoncreate" d:title="beforeValidationOnCreate" d:parental-control="1">
		<d:index d:value="beforeValidationOnCreate"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>beforeValidationOnCreate()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called before a new object is validated.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">beforeValidationOnCreate([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `fixObj` method ---&gt;
&lt;cfset beforeValidationOnCreate(&quot;fixObj&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="beforevalidationonupdate" d:title="beforeValidationOnUpdate" d:parental-control="1">
		<d:index d:value="beforeValidationOnUpdate"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>beforeValidationOnUpdate()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called before an existing object is validated.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">beforeValidationOnUpdate([ <em>methods</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Instruct Wheels to call the `fixObj` method ---&gt;
&lt;cfset beforeValidationOnUpdate(&quot;fixObj&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="belongsto" d:title="belongsTo" d:parental-control="1">
		<d:index d:value="belongsTo"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>belongsTo()</code></h1>
	
		<h2>Description</h2>
		<p>Sets up a `belongsTo` association between this model and the specified one. Use this association when this model contains a foreign key referencing another model.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">belongsTo(<em>name</em> [, <em>modelName</em>, <em>foreignKey</em>, <em>joinType</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Gives the association a name that you refer to when working with the association (in the `include` argument to @findAll, to name one example).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>modelName</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of associated model (usually not needed if you follow Wheels conventions because the model name will be deduced from the `name` argument).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>foreignKey</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Foreign key property name (usually not needed if you follow Wheels conventions since the foreign key name will be deduced from the `name` argument).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>joinType</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>inner</code></td>
				<td valign="top">Use to set the join type when joining associated tables. Possible values are `inner` (for `INNER JOIN`) and `outer` (for `LEFT OUTER JOIN`).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Specify that instances of this model belong to an author. (The table for this model should have a foreign key set on it, typically named `authorid`.) ---&gt;
&lt;cfset belongsTo(&quot;author&quot;)&gt;

&lt;!--- Same as above, but because we have broken away from the foreign key naming convention, we need to set `modelName` and `foreignKey` ---&gt;
&lt;cfset belongsTo(name=&quot;bookWriter&quot;, modelName=&quot;author&quot;, foreignKey=&quot;authorId&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="buttontag" d:title="buttonTag" d:parental-control="1">
		<d:index d:value="buttonTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>buttonTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a button `form` control.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">buttonTag([ <em>content</em>, <em>type</em>, <em>image</em>, <em>value</em>, <em>disable</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>content</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>Save changes</code></td>
				<td valign="top">Content to display inside the button.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>type</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>submit</code></td>
				<td valign="top">The type for the button: `button`, `reset`, or `submit`.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>image</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">File name of the image file to use in the button form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>value</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>save</code></td>
				<td valign="top">The value of the button when submitted.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>disable</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Whether or not to disable the button upon clicking. (Prevents double-clicking.)</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- view code ---&gt;
&lt;cfoutput&gt;
    #startFormTag(action=&quot;something&quot;)#
        &lt;!--- form controls go here ---&gt;
        #buttonTag(content=&quot;Submit this form&quot;, value=&quot;save&quot;)#
    #endFormTag()#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="buttonto" d:title="buttonTo" d:parental-control="1">
		<d:index d:value="buttonTo"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>buttonTo()</code></h1>
	
		<h2>Description</h2>
		<p>Creates a form containing a single button that submits to the URL. The URL is built the same way as the @linkTo function.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">buttonTo([ <em>text</em>, <em>confirm</em>, <em>image</em>, <em>disable</em>, <em>route</em>, <em>controller</em>, <em>action</em>, <em>key</em>, <em>params</em>, <em>anchor</em>, <em>onlyPath</em>, <em>host</em>, <em>protocol</em>, <em>port</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>text</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The text content of the button.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>confirm</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Pass a message here to cause a JavaScript confirmation dialog box to pop up containing the message.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>image</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">If you want to use an image for the button pass in the link to it here (relative from the `images` folder).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>disable</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Pass in `true` if you want the button to be disabled when clicked (can help prevent multiple clicks), or pass in a string if you want the button disabled and the text on the button updated (to &quot;please wait...&quot;, for example).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>route</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of a route that you have configured in `config/routes.cfm`.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>controller</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the controller to include in the URL.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>action</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the action to include in the URL.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>key</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Key(s) to include in the URL.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>params</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Any additional params to be set in the query string.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>anchor</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Sets an anchor name to be appended to the path.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>onlyPath</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">If `true`, returns only the relative URL (no protocol, host name or port).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>host</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set this to override the current host.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>protocol</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set this to override the current protocol.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>port</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>0</code></td>
				<td valign="top">Set this to override the current port number.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>#buttonTo(text=&quot;Delete Account&quot;, action=&quot;perFormDelete&quot;, disable=&quot;Wait...&quot;)#</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="caches" d:title="caches" d:parental-control="1">
		<d:index d:value="caches"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>caches()</code></h1>
	
		<h2>Description</h2>
		<p>Tells Wheels to cache one or more actions.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">caches([ <em>action</em>, <em>time</em>, <em>static</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>action</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Action(s) to cache. This argument is also aliased as `actions`.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>time</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>60</code></td>
				<td valign="top">Minutes to cache the action(s) for.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>static</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to tell Wheels that this is a static page and that it can skip running the controller filters (before and after filters set on actions) and application events (onSessionStart, onRequestStart etc).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cfset caches(actions=&quot;browseByUser,browseByTitle&quot;, time=30)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="capitalize" d:title="capitalize" d:parental-control="1">
		<d:index d:value="capitalize"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>capitalize()</code></h1>
	
		<h2>Description</h2>
		<p>Returns the text with the first character converted to uppercase.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">capitalize(<em>text</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>text</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Text to capitalize.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Capitalize a sentence, will result in &quot;Wheels is a framework&quot; ---&gt;
#capitalize(&quot;wheels is a framework&quot;)#</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="changedfrom" d:title="changedFrom" d:parental-control="1">
		<d:index d:value="changedFrom"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>changedFrom()</code></h1>
	
		<h2>Description</h2>
		<p>Returns the previous value of a property that has changed. Returns an empty string if no previous value exists. Wheels will keep a note of the previous property value until the object is saved to the database.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">changedFrom(<em>property</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of property to get the previous value for.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get a member object and change the `email` property on it ---&gt;
&lt;cfset member = model(&quot;member&quot;).findByKey(params.memberId)&gt;
&lt;cfset member.email = params.newEmail&gt;

&lt;!--- Get the previous value (what the `email` property was before it was changed)---&gt;
&lt;cfset oldValue = member.changedFrom(&quot;email&quot;)&gt;

&lt;!--- The above can also be done using a dynamic function like this ---&gt;
&lt;cfset oldValue = member.emailChangedFrom()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="changedproperties" d:title="changedProperties" d:parental-control="1">
		<d:index d:value="changedProperties"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>changedProperties()</code></h1>
	
		<h2>Description</h2>
		<p>Returns a list of the object properties that have been changed but not yet saved to the database.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">changedProperties()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get an object, change it, and then ask for its changes (will return a list of the property names that have changed, not the values themselves) ---&gt;
&lt;cfset member = model(&quot;member&quot;).findByKey(params.memberId)&gt;
&lt;cfset member.firstName = params.newFirstName&gt;
&lt;cfset member.email = params.newEmail&gt;
&lt;cfset changedProperties = member.changedProperties()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="checkbox" d:title="checkBox" d:parental-control="1">
		<d:index d:value="checkBox"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>checkBox()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a check box form control based on the supplied `objectName` and `property`. In most cases, this function generates a form field that should represent a `boolean` style field in your data. Use @checkBoxTag or @hasManyCheckBox to generate check boxes for selecting multiple values. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">checkBox(<em>objectName</em>, <em>property</em> [, <em>association</em>, <em>position</em>, <em>checkedValue</em>, <em>uncheckedValue</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em>, <em>errorElement</em>, <em>errorClass</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>objectName</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The variable name of the object to build the form control for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the property to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>association</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>position</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>checkedValue</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>1</code></td>
				<td valign="top">The value of the check box when it's in the `checked` state.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>uncheckedValue</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>0</code></td>
				<td valign="top">The value of the check box when it's in the `unchecked` state.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>useDefaultLabel</code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>errorElement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>span</code></td>
				<td valign="top">HTML tag to wrap the form control with when the object contains errors.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>errorClass</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>fieldWithErrors</code></td>
				<td valign="top">The class name of the HTML tag that wraps the form control when there are errors.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Basic example of a check box for a boolean field ---&gt;
&lt;cfoutput&gt;
    #checkBox(objectName=&quot;photo&quot;, property=&quot;isPublic&quot;, label=&quot;Display this photo publicly.&quot;)#
&lt;/cfoutput&gt;

&lt;!--- Shows check boxes for selecting public access for all photos provided by the `photos` association and nested properties ---&gt;
&lt;cfoutput&gt;
	&lt;cfloop from=&quot;1&quot; to=&quot;#ArrayLen(user.photos)#&quot; index=&quot;i&quot;&gt;
		&lt;div&gt;
			&lt;h3&gt;#user.photos[i].title#:&lt;/h3&gt;
			&lt;div&gt;
				#checkBox(objectName=&quot;user&quot;, association=&quot;photos&quot;, position=i, property=&quot;isPublic&quot;, label=&quot;Display this photo publicly.&quot;)#
			&lt;/div&gt;
		&lt;/div&gt;
	&lt;/cfloop&gt;
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="checkboxtag" d:title="checkBoxTag" d:parental-control="1">
		<d:index d:value="checkBoxTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>checkBoxTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a check box form control based on the supplied `name`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">checkBoxTag(<em>name</em> [, <em>checked</em>, <em>value</em>, <em>uncheckedValue</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>checked</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether or not the check box should be checked by default.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>value</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>1</code></td>
				<td valign="top">Value of check box in its `checked` state.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>uncheckedValue</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The value of the check box when it's on the `unchecked` state.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Example 1: Basic usage involves a `label`, `name`, and `value` ---&gt;
&lt;cfoutput&gt;
    #checkBoxTag(name=&quot;subscribe&quot;, value=&quot;true&quot;, label=&quot;Subscribe to our newsletter&quot;, checked=false)#
&lt;/cfoutput&gt;

&lt;!--- Example 2: Loop over a query to display choices and whether or not they are checked ---&gt;
&lt;!--- - Controller code ---&gt;
&lt;cfset pizza = model(&quot;pizza&quot;).findByKey(session.pizzaId)&gt;
&lt;cfset selectedToppings = pizza.toppings()&gt;
&lt;cfset toppings = model(&quot;topping&quot;).findAll(order=&quot;name&quot;)&gt;

&lt;!--- View code ---&gt;
&lt;fieldset&gt;
	&lt;legend&gt;Toppings&lt;/legend&gt;
	&lt;cfoutput query=&quot;toppings&quot;&gt;
		#checkBoxTag(name=&quot;toppings&quot;, value=&quot;true&quot;, label=toppings.name, checked=YesNoFormat(ListFind(ValueList(selectedToppings.id), toppings.id))#
	&lt;/cfoutput&gt;
&lt;/fieldset&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="clearerrors" d:title="clearErrors" d:parental-control="1">
		<d:index d:value="clearErrors"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>clearErrors()</code></h1>
	
		<h2>Description</h2>
		<p>Clears out all errors set on the object or only the ones set for a specific property or name.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">clearErrors([ <em>property</em>, <em>name</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Specify a property name here if you want to clear all errors set on that property.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Specify an error name here if you want to clear all errors set with that error name.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Clear all errors on the object as a whole ---&gt;
&lt;cfset this.clearErrors()&gt;

&lt;!--- Clear all errors on `firstName` ---&gt;
&lt;cfset this.clearErrors(&quot;firstName&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="columndataforproperty" d:title="columnDataForProperty" d:parental-control="1">
		<d:index d:value="columnDataForProperty"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>columnDataForProperty()</code></h1>
	
		<h2>Description</h2>
		<p>Returns a struct with data for the named property.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">columnDataForProperty(<em>property</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of column to retrieve data for.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get an object, set a value and then see if the property exists ---&gt;
&lt;cfset employee = model(&quot;employee&quot;).new()&gt;
&lt;cfset employee.columnDataForProperty(&quot;firstName&quot;)&gt;&lt;!--- returns column struct ---&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="columnforproperty" d:title="columnForProperty" d:parental-control="1">
		<d:index d:value="columnForProperty"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>columnForProperty()</code></h1>
	
		<h2>Description</h2>
		<p>Returns the column name mapped for the named model property.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">columnForProperty(<em>property</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of property to inspect.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get an object, set a value and then see if the property exists ---&gt;
&lt;cfset employee = model(&quot;employee&quot;).new()&gt;
&lt;cfset employee.columnForProperty(&quot;firstName&quot;)&gt;&lt;!--- returns column name, in this case &quot;firstname&quot; if the convention is used ---&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="columnnames" d:title="columnNames" d:parental-control="1">
		<d:index d:value="columnNames"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>columnNames()</code></h1>
	
		<h2>Description</h2>
		<p>Returns a list of column names in the table mapped to this model. The list is ordered according to the columns' ordinal positions in the database table.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">columnNames()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get a list of all the column names in the table mapped to the `author` model ---&gt;
&lt;cfset columns = model(&quot;author&quot;).columnNames()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="columns" d:title="columns" d:parental-control="1">
		<d:index d:value="columns"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>columns()</code></h1>
	
		<h2>Description</h2>
		<p>Returns an array of columns names for the table associated with this class. Does not include calculated properties that will be generated by the Wheels ORM.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">columns()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get the columns names in the order they are in the database ---&gt;
&lt;cfset employee = model(&quot;employee&quot;).columns()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="compareto" d:title="compareTo" d:parental-control="1">
		<d:index d:value="compareTo"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>compareTo()</code></h1>
	
		<h2>Description</h2>
		<p>Pass in another Wheels model object to see if the two objects are the same.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">compareTo()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Load a user requested in the URL/form and restrict access if it doesn't match the user stored in the session ---&gt;
&lt;cfset user = model(&quot;user&quot;).findByKey(params.key)&gt;
&lt;cfif not user.compareTo(session.user)&gt;
	&lt;cfset renderPage(action=&quot;accessDenied&quot;)&gt;
&lt;/cfif&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="contentfor" d:title="contentFor" d:parental-control="1">
		<d:index d:value="contentFor"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>contentFor()</code></h1>
	
		<h2>Description</h2>
		<p>Used to store a section's output for rendering within a layout. This content store acts as a stack, so you can store multiple pieces of content for a given section.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">contentFor([ <em>position</em>, <em>overwrite</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>position</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>last</code></td>
				<td valign="top">The position in the section's stack where you want the content placed. Valid values are `first`, `last`, or the numeric position.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>overwrite</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether or not to overwrite any of the content. Valid values are `false`, `true`, or `all`.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In your view ---&gt;
&lt;cfsavecontent variable=&quot;mySidebar&quot;&gt;
&lt;h1&gt;My Sidebar Text&lt;/h1&gt;
&lt;/cfsavecontent&gt;
&lt;cfset contentFor(sidebar=mySidebar)&gt;

&lt;!--- In your layout ---&gt;
&lt;html&gt;
&lt;head&gt;
    &lt;title&gt;My Site&lt;/title&gt;
&lt;/head&gt;
&lt;body&gt;

&lt;cfoutput&gt;
#includeContent(&quot;sidebar&quot;)#

#includeContent()#
&lt;/cfoutput&gt;

&lt;/body&gt;
&lt;/html&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="contentforlayout" d:title="contentForLayout" d:parental-control="1">
		<d:index d:value="contentForLayout"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>contentForLayout()</code></h1>
	
		<h2>Description</h2>
		<p>Includes content for the `body` section, which equates to the output generated by the view template run by the request.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">contentForLayout()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In `views/layout.cfm` ---&gt;
&lt;html&gt;
&lt;head&gt;
	&lt;title&gt;My Site&lt;/title&gt;
&lt;/head&gt;

&lt;body&gt;
&lt;cfoutput&gt;#contentForLayout()#&lt;/cfoutput&gt;
&lt;/body&gt;

&lt;/html&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="controller" d:title="controller" d:parental-control="1">
		<d:index d:value="controller"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>controller()</code></h1>
	
		<h2>Description</h2>
		<p>Creates and returns a controller object with your own custom `name` and `params`. Used primarily for testing purposes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">controller(<em>name</em> [, <em>params</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the controller to create.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>params</code></td>
				<td valign="top"><code>struct</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">The params struct (combination of `form` and `URL` variables).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cfset testController = controller(&quot;users&quot;, params)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="count" d:title="count" d:parental-control="1">
		<d:index d:value="count"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>count()</code></h1>
	
		<h2>Description</h2>
		<p>Returns the number of rows that match the arguments (or all rows if no arguments are passed in). Uses the SQL function `COUNT`. If no records can be found to perform the calculation on, `0` is returned.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">count([ <em>where</em>, <em>include</em>, <em>parameterize</em>, <em>includeSoftDeletes</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>where</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `&lt;&gt;`, `&lt;`, `&lt;=`, `&gt;`, `&gt;=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>include</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeSoftDeletes</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">You can set this argument to `true` to include soft-deleted records in the results.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Count how many authors there are in the table ---&gt;
&lt;cfset authorCount = model(&quot;author&quot;).count()&gt;

&lt;!--- Count how many authors that have a last name starting with an &quot;A&quot; ---&gt;
&lt;cfset authorOnACount = model(&quot;author&quot;).count(where=&quot;lastName LIKE 'A%'&quot;)&gt;

&lt;!--- Count how many authors that have written books starting with an &quot;A&quot; ---&gt;
&lt;cfset authorWithBooksOnACount = model(&quot;author&quot;).count(include=&quot;books&quot;, where=&quot;booktitle LIKE 'A%'&quot;)&gt;

&lt;!--- Count the number of comments on a specific post (a `hasMany` association from `post` to `comment` is required) ---&gt;
&lt;!--- The `commentCount` method will call `model(&quot;comment&quot;).count(where=&quot;postId=#post.id#&quot;)` internally ---&gt;
&lt;cfset aPost = model(&quot;post&quot;).findByKey(params.postId)&gt;
&lt;cfset amount = aPost.commentCount()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="create" d:title="create" d:parental-control="1">
		<d:index d:value="create"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>create()</code></h1>
	
		<h2>Description</h2>
		<p>Creates a new object, saves it to the database (if the validation permits it), and returns it. If the validation fails, the unsaved object (with errors added to it) is still returned. Property names and values can be passed in either using named arguments or as a struct to the `properties` argument.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">create([ <em>properties</em>, <em>parameterize</em>, <em>reload</em>, <em>transaction</em>, <em>callbacks</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>struct</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">The properties you want to set on the object (can also be passed in as named arguments).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>reload</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to reload the object from the database once an insert/update has completed.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>transaction</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>callbacks</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to disable callbacks for this operation.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Create a new author and save it to the database ---&gt;
&lt;cfset newAuthor = model(&quot;author&quot;).create(params.author)&gt;

&lt;!--- Same as above using named arguments ---&gt;
&lt;cfset newAuthor = model(&quot;author&quot;).create(firstName=&quot;John&quot;, lastName=&quot;Doe&quot;)&gt;

&lt;!--- Same as above using both named arguments and a struct ---&gt;
&lt;cfset newAuthor = model(&quot;author&quot;).create(active=1, properties=params.author)&gt;

&lt;!--- If you have a `hasOne` or `hasMany` association setup from `customer` to `order`, you can do a scoped call. (The `createOrder` method below will call `model(&quot;order&quot;).create(customerId=aCustomer.id, shipping=params.shipping)` internally.) ---&gt;
&lt;cfset aCustomer = model(&quot;customer&quot;).findByKey(params.customerId)&gt;
&lt;cfset anOrder = aCustomer.createOrder(shipping=params.shipping)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="cycle" d:title="cycle" d:parental-control="1">
		<d:index d:value="cycle"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>cycle()</code></h1>
	
		<h2>Description</h2>
		<p>Cycles through list values every time it is called.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">cycle(<em>values</em> [, <em>name</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>values</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">List of values to cycle through.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>default</code></td>
				<td valign="top">Name to give the cycle. Useful when you use multiple cycles on a page.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Alternating table row colors ---&gt;
&lt;table&gt;
	&lt;thead&gt;
		&lt;tr&gt;
			&lt;th&gt;Name&lt;/th&gt;
			&lt;th&gt;Phone&lt;/th&gt;
		&lt;/tr&gt;
	&lt;/thead&gt;
	&lt;tbody&gt;
		&lt;cfoutput query=&quot;employees&quot;&gt;
			&lt;tr class=&quot;#cycle(&quot;odd,even&quot;)#&quot;&gt;
				&lt;td&gt;#employees.name#&lt;/td&gt;
				&lt;td&gt;#employees.phone#&lt;/td&gt;
			&lt;/tr&gt;
		&lt;/cfoutput&gt;
	&lt;/tbody&gt;
&lt;/table&gt;

&lt;!--- Alternating row colors and shrinking emphasis ---&gt;
&lt;cfoutput query=&quot;employees&quot; group=&quot;departmentId&quot;&gt;
	&lt;div class=&quot;#cycle(values=&quot;even,odd&quot;, name=&quot;row&quot;)#&quot;&gt;
		&lt;ul&gt;
			&lt;cfoutput&gt;
				&lt;cfset rank = cycle(values=&quot;president,vice-president,director,manager,specialist,intern&quot;, name=&quot;position&quot;)&gt;
				&lt;li class=&quot;#rank#&quot;&gt;#categories.categoryName#&lt;/li&gt;
				&lt;cfset resetCycle(&quot;emphasis&quot;)&gt;
			&lt;/cfoutput&gt;
		&lt;/ul&gt;
	&lt;/div&gt;
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="datasource" d:title="dataSource" d:parental-control="1">
		<d:index d:value="dataSource"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>dataSource()</code></h1>
	
		<h2>Description</h2>
		<p>Use this method to override the data source connection information for this model.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">dataSource(<em>datasource</em> [, <em>username</em>, <em>password</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>datasource</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The data source name to connect to.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>username</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The username for the data source.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>password</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The password for the data source.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In models/User.cfc ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;!--- Tell Wheels to use the data source named `users_source` instead of the default one whenever this model makes SQL calls  ---&gt;
  			&lt;cfset dataSource(&quot;users_source&quot;)&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="dateselect" d:title="dateSelect" d:parental-control="1">
		<d:index d:value="dateSelect"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>dateSelect()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing three select form controls for month, day, and year based on the supplied `objectName` and `property`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">dateSelect([ <em>objectName</em>, <em>property</em>, <em>association</em>, <em>position</em>, <em>order</em>, <em>separator</em>, <em>startYear</em>, <em>endYear</em>, <em>monthDisplay</em>, <em>includeBlank</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em>, <em>errorElement</em>, <em>errorClass</em>, <em>combine</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>objectName</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The variable name of the object to build the form control for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the property to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>association</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>position</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>order</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>month,day,year</code></td>
				<td valign="top">Use to change the order of or exclude date select tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>separator</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Use to change the character that is displayed between the date select tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>startYear</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>2005</code></td>
				<td valign="top">First year in select list.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>endYear</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>2015</code></td>
				<td valign="top">Last year in select list.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>monthDisplay</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>names</code></td>
				<td valign="top">Pass in `names`, `numbers`, or `abbreviations` to control display.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeBlank</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, &quot;- Select One -&quot;).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">The label text to use in the form control. The label will be applied to all `select` tags, but you can pass in a list to cutomize each one individually.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>errorElement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>span</code></td>
				<td valign="top">HTML tag to wrap the form control with when the object contains errors.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>errorClass</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>fieldWithErrors</code></td>
				<td valign="top">The class name of the HTML tag that wraps the form control when there are errors.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>combine</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set to `false` to not combine the select parts into a single `DateTime` object.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- View code ---&gt;
&lt;cfoutput&gt;
	#dateSelect(objectName=&quot;user&quot;, property=&quot;dateOfBirth&quot;)#
&lt;/cfoutput&gt;

&lt;!--- Show fields to select month and year ---&gt;
&lt;cfoutput&gt;
	#dateSelect(objectName=&quot;order&quot;, property=&quot;expirationDate&quot;, order=&quot;month,year&quot;)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="dateselecttags" d:title="dateSelectTags" d:parental-control="1">
		<d:index d:value="dateSelectTags"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>dateSelectTags()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing three select form controls (month, day, and year) based on a `name` and `value`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">dateSelectTags(<em>name</em> [, <em>selected</em>, <em>order</em>, <em>separator</em>, <em>startYear</em>, <em>endYear</em>, <em>monthDisplay</em>, <em>includeBlank</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em>, <em>combine</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>selected</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Value of option that should be selected by default.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>order</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>month,day,year</code></td>
				<td valign="top">Use to change the order of or exclude date select tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>separator</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Use to change the character that is displayed between the date select tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>startYear</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>2005</code></td>
				<td valign="top">First year in select list.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>endYear</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>2015</code></td>
				<td valign="top">Last year in select list.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>monthDisplay</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>names</code></td>
				<td valign="top">Pass in `names`, `numbers`, or `abbreviations` to control display.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeBlank</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, &quot;- Select One -&quot;).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control. The label will be applied to all `select` tags, but you can pass in a list to cutomize each one individually.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>combine</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set to `false` to not combine the select parts into a single `DateTime` object.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- This &quot;Tag&quot; version of function accepts `name` and `selected` instead of binding to a model object ---&gt;
&lt;cfoutput&gt;
	#dateSelectTags(name=&quot;dateStart&quot;, selected=params.dateStart)#
&lt;/cfoutput&gt;

&lt;!--- Show fields for month and year only ---&gt;
&lt;cfoutput&gt;
	#dateSelectTags(name=&quot;expiration&quot;, selected=params.expiration, order=&quot;month,year&quot;)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="datetimeselect" d:title="dateTimeSelect" d:parental-control="1">
		<d:index d:value="dateTimeSelect"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>dateTimeSelect()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing six select form controls (three for date selection and the remaining three for time selection) based on the supplied `objectName` and `property`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">dateTimeSelect(<em>objectName</em>, <em>property</em> [, <em>association</em>, <em>position</em>, <em>dateOrder</em>, <em>dateSeparator</em>, <em>startYear</em>, <em>endYear</em>, <em>monthDisplay</em>, <em>timeOrder</em>, <em>timeSeparator</em>, <em>minuteStep</em>, <em>separator</em>, <em>includeBlank</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em>, <em>errorElement</em>, <em>errorClass</em>, <em>combine</em>, <em>twelveHour</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>objectName</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The variable name of the object to build the form control for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the property to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>association</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>position</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>dateOrder</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>month,day,year</code></td>
				<td valign="top">Use to change the order of or exclude date select tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>dateSeparator</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Use to change the character that is displayed between the date select tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>startYear</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>2005</code></td>
				<td valign="top">First year in select list.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>endYear</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>2015</code></td>
				<td valign="top">Last year in select list.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>monthDisplay</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>names</code></td>
				<td valign="top">Pass in `names`, `numbers`, or `abbreviations` to control display.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>timeOrder</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>hour,minute,second</code></td>
				<td valign="top">Use to change the order of or exclude time select tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>timeSeparator</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>:</code></td>
				<td valign="top">Use to change the character that is displayed between the time select tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>minuteStep</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>1</code></td>
				<td valign="top">Pass in `10` to only show minute 10, 20, 30, etc.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>separator</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code> - </code></td>
				<td valign="top">Use to change the character that is displayed between the first and second set of select tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeBlank</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, &quot;- Select One -&quot;).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">The label text to use in the form control. The label will be applied to all `select` tags, but you can pass in a list to cutomize each one individually.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>errorElement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>span</code></td>
				<td valign="top">HTML tag to wrap the form control with when the object contains errors.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>errorClass</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>fieldWithErrors</code></td>
				<td valign="top">The class name of the HTML tag that wraps the form control when there are errors.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>combine</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set to `false` to not combine the select parts into a single `DateTime` object.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>twelveHour</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- View code ---&gt;
&lt;cfoutput&gt;
    #dateTimeSelect(objectName=&quot;article&quot;, property=&quot;publishedAt&quot;)#
&lt;/cfoutput&gt;

&lt;!--- Show fields for month, day, hour, and minute ---&gt;
&lt;cfoutput&gt;
	#dateTimeSelect(objectName=&quot;appointment&quot;, property=&quot;dateTimeStart&quot;, dateOrder=&quot;month,day&quot;, timeOrder=&quot;hour,minute&quot;)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="datetimeselecttags" d:title="dateTimeSelectTags" d:parental-control="1">
		<d:index d:value="dateTimeSelectTags"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>dateTimeSelectTags()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing six select form controls (three for date selection and the remaining three for time selection) based on a `name`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">dateTimeSelectTags(<em>name</em> [, <em>selected</em>, <em>dateOrder</em>, <em>dateSeparator</em>, <em>startYear</em>, <em>endYear</em>, <em>monthDisplay</em>, <em>timeOrder</em>, <em>timeSeparator</em>, <em>minuteStep</em>, <em>separator</em>, <em>includeBlank</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em>, <em>combine</em>, <em>twelveHour</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>selected</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Value of option that should be selected by default.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>dateOrder</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>month,day,year</code></td>
				<td valign="top">Use to change the order of or exclude date select tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>dateSeparator</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Use to change the character that is displayed between the date select tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>startYear</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>2005</code></td>
				<td valign="top">First year in select list.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>endYear</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>2015</code></td>
				<td valign="top">Last year in select list.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>monthDisplay</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>names</code></td>
				<td valign="top">Pass in `names`, `numbers`, or `abbreviations` to control display.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>timeOrder</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>hour,minute,second</code></td>
				<td valign="top">Use to change the order of or exclude time select tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>timeSeparator</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>:</code></td>
				<td valign="top">Use to change the character that is displayed between the time select tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>minuteStep</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>1</code></td>
				<td valign="top">Pass in `10` to only show minute 10, 20, 30, etc.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>separator</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code> - </code></td>
				<td valign="top">Use to change the character that is displayed between the first and second set of select tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeBlank</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, &quot;- Select One -&quot;).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control. The label will be applied to all `select` tags, but you can pass in a list to cutomize each one individually.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>combine</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set to `false` to not combine the select parts into a single `DateTime` object.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>twelveHour</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- This &quot;Tag&quot; version of the function accepts a `name` and `selected` instead of binding to a model object ---&gt;
&lt;cfoutput&gt;
    #dateTimeSelectTags(name=&quot;dateTimeStart&quot;, selected=params.dateTimeStart)#
&lt;/cfoutput&gt;

&lt;!--- Show fields for month, day, hour, and minute ---&gt;
&lt;cfoutput&gt;
	#dateTimeSelectTags(name=&quot;dateTimeStart&quot;, selected=params.dateTimeStart, dateOrder=&quot;month,day&quot;, timeOrder=&quot;hour,minute&quot;)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="dayselecttag" d:title="daySelectTag" d:parental-control="1">
		<d:index d:value="daySelectTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>daySelectTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a select form control for the days of the week based on the supplied `name`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">daySelectTag(<em>name</em> [, <em>selected</em>, <em>includeBlank</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>selected</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The day that should be selected initially.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>includeBlank</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, &quot;- Select One -&quot;).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- This &quot;Tag&quot; version of the function accepts a `name` and `selected` instead of binding to a model object ---&gt;
&lt;cfoutput&gt;
    #daySelectTag(name=&quot;dayOfWeek&quot;, selected=params.dayOfWeek)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="delete" d:title="delete" d:parental-control="1">
		<d:index d:value="delete"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>delete()</code></h1>
	
		<h2>Description</h2>
		<p>Deletes the object, which means the row is deleted from the database (unless prevented by a `beforeDelete` callback). Returns `true` on successful deletion of the row, `false` otherwise.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">delete([ <em>parameterize</em>, <em>transaction</em>, <em>callbacks</em>, <em>includeSoftDeletes</em>, <em>softDelete</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>transaction</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>callbacks</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to disable callbacks for this operation.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeSoftDeletes</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">You can set this argument to `true` to include soft-deleted records in the results.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>softDelete</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to permanently delete a record, even if it has a soft delete column.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get a post object and then delete it from the database ---&gt;
&lt;cfset post = model(&quot;post&quot;).findByKey(33)&gt;
&lt;cfset post.delete()&gt;

&lt;!--- If you have a `hasMany` association setup from `post` to `comment`, you can do a scoped call. (The `deleteComment` method below will call `comment.delete()` internally.) ---&gt;
&lt;cfset post = model(&quot;post&quot;).findByKey(params.postId)&gt;
&lt;cfset comment = model(&quot;comment&quot;).findByKey(params.commentId)&gt;
&lt;cfset post.deleteComment(comment)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="deleteall" d:title="deleteAll" d:parental-control="1">
		<d:index d:value="deleteAll"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>deleteAll()</code></h1>
	
		<h2>Description</h2>
		<p>Deletes all records that match the `where` argument. By default, objects will not be instantiated and therefore callbacks and validations are not invoked. You can change this behavior by passing in `instantiate=true`. Returns the number of records that were deleted.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">deleteAll([ <em>where</em>, <em>include</em>, <em>reload</em>, <em>parameterize</em>, <em>instantiate</em>, <em>transaction</em>, <em>callbacks</em>, <em>includeSoftDeletes</em>, <em>softDelete</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>where</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `&lt;&gt;`, `&lt;`, `&lt;=`, `&gt;`, `&gt;=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>include</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>reload</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.)</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>instantiate</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether or not to instantiate the object(s) first. When objects are not instantiated, any callbacks and validations set on them will be skipped.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>transaction</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>callbacks</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to disable callbacks for this operation.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeSoftDeletes</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">You can set this argument to `true` to include soft-deleted records in the results.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>softDelete</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to permanently delete a record, even if it has a soft delete column.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Delete all inactive users without instantiating them (will skip validation and callbacks) ---&gt;
&lt;cfset recordsDeleted = model(&quot;user&quot;).deleteAll(where=&quot;inactive=1&quot;, instantiate=false)&gt;

&lt;!--- If you have a `hasMany` association setup from `post` to `comment`, you can do a scoped call. (The `deleteAllComments` method below will call `model(&quot;comment&quot;).deleteAll(where=&quot;postId=#post.id#&quot;)` internally.) ---&gt;
&lt;cfset post = model(&quot;post&quot;).findByKey(params.postId)&gt;
&lt;cfset howManyDeleted = post.deleteAllComments()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="deletebykey" d:title="deleteByKey" d:parental-control="1">
		<d:index d:value="deleteByKey"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>deleteByKey()</code></h1>
	
		<h2>Description</h2>
		<p>Finds the record with the supplied key and deletes it. Returns `true` on successful deletion of the row, `false` otherwise.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">deleteByKey(<em>key</em> [, <em>reload</em>, <em>transaction</em>, <em>callbacks</em>, <em>includeSoftDeletes</em>, <em>softDelete</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>key</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Primary key value(s) of the record to fetch. Separate with comma if passing in multiple primary key values. Accepts a string, list, or a numeric value.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>reload</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.)</td>
			</tr>
			
			<tr>
				<td valign="top"><code>transaction</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>callbacks</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to disable callbacks for this operation.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>includeSoftDeletes</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">You can set this argument to `true` to include soft-deleted records in the results.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>softDelete</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to permanently delete a record, even if it has a soft delete column.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Delete the user with the primary key value of `1` ---&gt;
&lt;cfset result = model(&quot;user&quot;).deleteByKey(1)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="deleteone" d:title="deleteOne" d:parental-control="1">
		<d:index d:value="deleteOne"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>deleteOne()</code></h1>
	
		<h2>Description</h2>
		<p>Gets an object based on conditions and deletes it.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">deleteOne([ <em>where</em>, <em>order</em>, <em>reload</em>, <em>transaction</em>, <em>callbacks</em>, <em>includeSoftDeletes</em>, <em>softDelete</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>where</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `&lt;&gt;`, `&lt;`, `&lt;=`, `&gt;`, `&gt;=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>order</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Maps to the `ORDER BY` clause of the query. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>reload</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.)</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>transaction</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>callbacks</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to disable callbacks for this operation.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeSoftDeletes</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">You can set this argument to `true` to include soft-deleted records in the results.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>softDelete</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to permanently delete a record, even if it has a soft delete column.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Delete the user that signed up last ---&gt;
&lt;cfset result = model(&quot;user&quot;).deleteOne(order=&quot;signupDate DESC&quot;)&gt;

&lt;!--- If you have a `hasOne` association setup from `user` to `profile` you can do a scoped call (the `deleteProfile` method below will call `model(&quot;profile&quot;).deleteOne(where=&quot;userId=#aUser.id#&quot;)` internally) ---&gt;
&lt;cfset aUser = model(&quot;user&quot;).findByKey(params.userId)&gt;
&lt;cfset aUser.deleteProfile()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="deobfuscateparam" d:title="deobfuscateParam" d:parental-control="1">
		<d:index d:value="deobfuscateParam"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>deobfuscateParam()</code></h1>
	
		<h2>Description</h2>
		<p>Deobfuscates a value.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">deobfuscateParam(<em>param</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>param</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Value to deobfuscate.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get the original value from an obfuscated one ---&gt;
&lt;cfset originalValue = deobfuscateParam(&quot;b7ab9a50&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="distanceoftimeinwords" d:title="distanceOfTimeInWords" d:parental-control="1">
		<d:index d:value="distanceOfTimeInWords"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>distanceOfTimeInWords()</code></h1>
	
		<h2>Description</h2>
		<p>Pass in two dates to this method, and it will return a string describing the difference between them.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">distanceOfTimeInWords(<em>fromTime</em>, <em>toTime</em> [, <em>includeSeconds</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>fromTime</code></td>
				<td valign="top"><code>date</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Date to compare from.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>toTime</code></td>
				<td valign="top"><code>date</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Date to compare to.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>includeSeconds</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether or not to include the number of seconds in the returned string.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cfset aWhileAgo = Now() - 30&gt;
	&lt;cfset rightNow = Now()&gt;
	&lt;cfoutput&gt;#distanceOfTimeInWords(aWhileAgo, rightNow)#&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="endformtag" d:title="endFormTag" d:parental-control="1">
		<d:index d:value="endFormTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>endFormTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing the closing `form` tag.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">endFormTag()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- view code ---&gt;
&lt;cfoutput&gt;
    #startFormTag(action=&quot;create&quot;)#
        &lt;!--- your form controls ---&gt;
    #endFormTag()#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="errorcount" d:title="errorCount" d:parental-control="1">
		<d:index d:value="errorCount"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>errorCount()</code></h1>
	
		<h2>Description</h2>
		<p>Returns the number of errors this object has associated with it. Specify `property` or `name` if you wish to count only specific errors.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">errorCount([ <em>property</em>, <em>name</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Specify a property name here if you want to count only errors set on a specific property.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Specify an error name here if you want to count only errors set with a specific error name.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Check how many errors are set on the object ---&gt;
&lt;cfif author.errorCount() GTE 10&gt;
	&lt;!--- Do something to deal with this very erroneous author here... ---&gt;
&lt;/cfif&gt;

&lt;!--- Check how many errors are associated with the `email` property ---&gt;
&lt;cfif author.errorCount(&quot;email&quot;) gt 0&gt;
	&lt;!--- Do something to deal with this erroneous author here... ---&gt;
&lt;/cfif&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="errormessageon" d:title="errorMessageOn" d:parental-control="1">
		<d:index d:value="errorMessageOn"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>errorMessageOn()</code></h1>
	
		<h2>Description</h2>
		<p>Returns the error message, if one exists, on the object's property. If multiple error messages exist, the first one is returned.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">errorMessageOn(<em>objectName</em>, <em>property</em> [, <em>prependText</em>, <em>appendText</em>, <em>wrapperElement</em>, <em>class</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>objectName</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The variable name of the object to display the error message for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the property to display the error message for.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependText</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the error message.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendText</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the error message.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>wrapperElement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>span</code></td>
				<td valign="top">HTML element to wrap the error message in.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>class</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>errorMessage</code></td>
				<td valign="top">CSS class to set on the wrapper element.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- view code ---&gt;
	&lt;cfoutput&gt;
	    #errorMessageOn(objectName=&quot;user&quot;, property=&quot;email&quot;)#
	&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="errormessagesfor" d:title="errorMessagesFor" d:parental-control="1">
		<d:index d:value="errorMessagesFor"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>errorMessagesFor()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a list (`ul` tag with a class of `error-messages`) containing all the error messages for all the properties of the object (if any). Returns an empty string otherwise.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">errorMessagesFor(<em>objectName</em> [, <em>class</em>, <em>showDuplicates</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>objectName</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The variable name of the object to display error messages for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>class</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>errorMessages</code></td>
				<td valign="top">CSS class to set on the `ul` element.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>showDuplicates</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Whether or not to show duplicate error messages.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- view code ---&gt;
&lt;cfoutput&gt;
    #errorMessagesFor(objectName=&quot;user&quot;)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="errorson" d:title="errorsOn" d:parental-control="1">
		<d:index d:value="errorsOn"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>errorsOn()</code></h1>
	
		<h2>Description</h2>
		<p>Returns an array of all errors associated with the supplied property (and error name if passed in).</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">errorsOn(<em>property</em> [, <em>name</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Specify the property name to return errors for here.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">If you want to return only errors on the above property set with a specific error name you can specify it here.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get all errors related to the email address of the user object ---&gt;
&lt;cfset errors = user.errorsOn(&quot;emailAddress&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="errorsonbase" d:title="errorsOnBase" d:parental-control="1">
		<d:index d:value="errorsOnBase"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>errorsOnBase()</code></h1>
	
		<h2>Description</h2>
		<p>Returns an array of all errors associated with the object as a whole (not related to any specific property).</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">errorsOnBase([ <em>name</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Specify an error name here to only return errors for that error name.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get all general type errors for the user object ---&gt;
&lt;cfset errors = user.errorsOnBase()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="excerpt" d:title="excerpt" d:parental-control="1">
		<d:index d:value="excerpt"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>excerpt()</code></h1>
	
		<h2>Description</h2>
		<p>Extracts an excerpt from text that matches the first instance of a given phrase.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">excerpt(<em>text</em>, <em>phrase</em> [, <em>radius</em>, <em>excerptString</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>text</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The text to extract an excerpt from.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>phrase</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The phrase to extract.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>radius</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>100</code></td>
				<td valign="top">Number of characters to extract surrounding the phrase.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>excerptString</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>...</code></td>
				<td valign="top">String to replace first and/or last characters with.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>#excerpt(text=&quot;ColdFusion Wheels is a Rails-like MVC framework for Adobe ColdFusion and Railo&quot;, phrase=&quot;framework&quot;, radius=5)#
-&gt; ... MVC framework for ...</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="exists" d:title="exists" d:parental-control="1">
		<d:index d:value="exists"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>exists()</code></h1>
	
		<h2>Description</h2>
		<p>Checks if a record exists in the table. You can pass in either a primary key value to the `key` argument or a string to the `where` argument.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">exists([ <em>key</em>, <em>where</em>, <em>reload</em>, <em>parameterize</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>key</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Primary key value(s) of the record to fetch. Separate with comma if passing in multiple primary key values. Accepts a string, list, or a numeric value.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>where</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `&lt;&gt;`, `&lt;`, `&lt;=`, `&gt;`, `&gt;=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>reload</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.)</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Checking if Joe exists in the database ---&gt;
&lt;cfset result = model(&quot;user&quot;).exists(where=&quot;firstName='Joe'&quot;)&gt;

&lt;!--- Checking if a specific user exists based on a primary key valued passed in through the URL/form in an if statement ---&gt;
&lt;cfif model(&quot;user&quot;).exists(keyparams.key)&gt;
	&lt;!--- Do something... ---&gt;
&lt;/cfif&gt;

&lt;!--- If you have a `belongsTo` association setup from `comment` to `post`, you can do a scoped call. (The `hasPost` method below will call `model(&quot;post&quot;).exists(comment.postId)` internally.) ---&gt;
&lt;cfset comment = model(&quot;comment&quot;).findByKey(params.commentId)&gt;
&lt;cfset commentHasAPost = comment.hasPost()&gt;

&lt;!--- If you have a `hasOne` association setup from `user` to `profile`, you can do a scoped call. (The `hasProfile` method below will call `model(&quot;profile&quot;).exists(where=&quot;userId=#user.id#&quot;)` internally.) ---&gt;
&lt;cfset user = model(&quot;user&quot;).findByKey(params.userId)&gt;
&lt;cfset userHasProfile = user.hasProfile()&gt;

&lt;!--- If you have a `hasMany` association setup from `post` to `comment`, you can do a scoped call. (The `hasComments` method below will call `model(&quot;comment&quot;).exists(where=&quot;postid=#post.id#&quot;)` internally.) ---&gt;
&lt;cfset post = model(&quot;post&quot;).findByKey(params.postId)&gt;
&lt;cfset postHasComments = post.hasComments()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="filefield" d:title="fileField" d:parental-control="1">
		<d:index d:value="fileField"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>fileField()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a file field form control based on the supplied `objectName` and `property`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">fileField(<em>objectName</em>, <em>property</em> [, <em>association</em>, <em>position</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em>, <em>errorElement</em>, <em>errorClass</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>objectName</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The variable name of the object to build the form control for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the property to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>association</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>position</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>useDefaultLabel</code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>errorElement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>span</code></td>
				<td valign="top">HTML tag to wrap the form control with when the object contains errors.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>errorClass</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>fieldWithErrors</code></td>
				<td valign="top">The class name of the HTML tag that wraps the form control when there are errors.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Provide a `label` and the required `objectName` and `property` ---&gt;
&lt;cfoutput&gt;
    #fileField(label=&quot;Photo&quot;, objectName=&quot;photo&quot;, property=&quot;imageFile&quot;)#
&lt;/cfoutput&gt;

&lt;!--- Display fields for photos provided by the `screenshots` association and nested properties ---&gt;
&lt;fieldset&gt;
	&lt;legend&gt;Screenshots&lt;/legend&gt;
	&lt;cfloop from=&quot;1&quot; to=&quot;#ArrayLen(site.screenshots)#&quot; index=&quot;i&quot;&gt;
		#fileField(label=&quot;File ##i#&quot;, objectName=&quot;site&quot;, association=&quot;screenshots&quot;, position=i, property=&quot;file&quot;)#
		#textField(label=&quot;Caption ##i#&quot;, objectName=&quot;site&quot;, association=&quot;screenshots&quot;, position=i, property=&quot;caption&quot;)#
	&lt;/cfloop&gt;
&lt;/fieldset&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="filefieldtag" d:title="fileFieldTag" d:parental-control="1">
		<d:index d:value="fileFieldTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>fileFieldTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a file form control based on the supplied `name`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">fileFieldTag(<em>name</em> [, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Basic usage usually involves a `label`, `name`, and `value` ---&gt;
&lt;cfoutput&gt;
    #fileFieldTag(label=&quot;Photo&quot;, name=&quot;photo&quot;, value=params.photo)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="filterchain" d:title="filterChain" d:parental-control="1">
		<d:index d:value="filterChain"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>filterChain()</code></h1>
	
		<h2>Description</h2>
		<p>Returns an array of all the filters set on this controller in the order in which they will be executed.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">filterChain([ <em>type</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>type</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>all</code></td>
				<td valign="top">Use this argument to return only `before` or `after` filters.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get filter chain, remove the first item, and set it back ---&gt;
&lt;cfset myFilterChain = filterChain()&gt;
&lt;cfset ArrayDeleteAt(myFilterChain, 1)&gt;
&lt;cfset setFilterChain(myFilterChain)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="filters" d:title="filters" d:parental-control="1">
		<d:index d:value="filters"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>filters()</code></h1>
	
		<h2>Description</h2>
		<p>Tells Wheels to run a function before an action is run or after an action has been run. You can also specify multiple functions and actions.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">filters(<em>through</em> [, <em>type</em>, <em>only</em>, <em>except</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>through</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Function(s) to execute before or after the action(s).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>type</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>before</code></td>
				<td valign="top">Whether to run the function(s) before or after the action(s).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>only</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Pass in a list of action names (or one action name) to tell Wheels that the filter function(s) should only be run on these actions.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>except</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Pass in a list of action names (or one action name) to tell Wheels that the filter function(s) should be run on all actions except the specified ones.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Always execute `restrictAccess` before all actions in this controller ---&gt;
&lt;cfset filters(&quot;restrictAccess&quot;)&gt;

&lt;!--- Always execute `isLoggedIn` and `checkIPAddress` (in that order) before all actions in this controller except the `home` and `login` actions ---&gt;
&lt;cfset filters(through=&quot;isLoggedIn,checkIPAddress&quot;, except=&quot;home,login&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="findall" d:title="findAll" d:parental-control="1">
		<d:index d:value="findAll"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>findAll()</code></h1>
	
		<h2>Description</h2>
		<p>Returns records from the database table mapped to this model according to the arguments passed in. (Use the `where` argument to decide which records to get, use the `order` argument to set in what order those records should be returned, and so on). The records will be returned as either a `cfquery` result set or an array of objects (depending on what the `returnAs` argument is set to). Instead of using the `where` argument, you can create cleaner code by making use of a concept called dynamic finders.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">findAll([ <em>where</em>, <em>order</em>, <em>group</em>, <em>select</em>, <em>distinct</em>, <em>include</em>, <em>maxRows</em>, <em>page</em>, <em>perPage</em>, <em>count</em>, <em>handle</em>, <em>cache</em>, <em>reload</em>, <em>parameterize</em>, <em>returnAs</em>, <em>returnIncluded</em>, <em>callbacks</em>, <em>includeSoftDeletes</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>where</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `&lt;&gt;`, `&lt;`, `&lt;=`, `&gt;`, `&gt;=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>order</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Maps to the `ORDER BY` clause of the query. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>group</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Maps to the `GROUP BY` clause of the query. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>select</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Determines how the `SELECT` clause for the query used to return data will look.	You can pass in a list of the properties (which map to columns) that you want returned from your table(s). If you don't set this argument at all, Wheels will select all properties from your table(s). If you specify a table name (e.g. `users.email`) or alias a column (e.g. `fn AS firstName`) in the list, then the entire list will be passed through unchanged and used in the `SELECT` clause of the query. By default, all column names in tables `JOIN`ed via the `include` argument will be prepended with the singular version of the included table name.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>distinct</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether to add the `DISTINCT` keyword to your `SELECT` clause. Wheels will, when necessary, add this automatically (when using pagination and a `hasMany` association is used in the `include` argument, to name one example).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>include</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>maxRows</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>-1</code></td>
				<td valign="top">Maximum number of records to retrieve. Passed on to the `maxRows` `cfquery` attribute. The default, `-1`, means that all records will be retrieved.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>page</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>0</code></td>
				<td valign="top">If you want to paginate records, you can do so by specifying a page number here. For example, getting records 11-20 would be page number 2 when `perPage` is kept at the default setting (10 records per page). The default, `0`, means that records won't be paginated and that the `perPage`, `count`, and `handle` arguments will be ignored.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>perPage</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>10</code></td>
				<td valign="top">When using pagination, you can specify how many records you want to fetch per page here. This argument is only used when the `page` argument has been passed in.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>count</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>0</code></td>
				<td valign="top">When using pagination and you know in advance how many records you want to paginate through, you can pass in that value here. Doing so will prevent Wheels from running a `COUNT` query to get this value. This argument is only used when the `page` argument has been passed in.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>handle</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>query</code></td>
				<td valign="top">Handle to use for the query in pagination. This is useful when you're paginating multiple queries and need to reference them in the @paginationLinks function, for example. This argument is only used when the `page` argument has been passed in.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>cache</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">If you want to cache the query, you can do so by specifying the number of minutes you want to cache the query for here. If you set it to `true`, the default cache time will be used (60 minutes).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>reload</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.)</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>returnAs</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>query</code></td>
				<td valign="top">Set this to `objects` to return an array of objects. Set this to `query` to return a query result set.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>returnIncluded</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">When `returnAs` is set to `objects`, you can set this argument to `false` to prevent returning objects fetched from associations specified in the `include` argument. This is useful when you only need to include associations for use in the `WHERE` clause only and want to avoid the performance hit that comes with object creation.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>callbacks</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">You can set this argument to `false` to prevent running the execution of callbacks for a method call.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeSoftDeletes</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">You can set this argument to `true` to include soft-deleted records in the results.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Getting only 5 users and ordering them randomly ---&gt;
&lt;cfset fiveRandomUsers = model(&quot;user&quot;).findAll(maxRows=5, order=&quot;random&quot;)&gt;

&lt;!--- Including an association (which in this case needs to be setup as a `belongsTo` association to `author` on the `article` model first)  ---&gt;
&lt;cfset articles = model(&quot;article&quot;).findAll(where=&quot;published=1&quot;, order=&quot;createdAt DESC&quot;, include=&quot;author&quot;)&gt;

&lt;!--- Similar to the above but using the association in the opposite direction (which needs to be setup as a `hasMany` association to `article` on the `author` model) ---&gt;
&lt;cfset bobsArticles = model(&quot;author&quot;).findAll(where=&quot;firstName='Bob'&quot;, include=&quot;articles&quot;)&gt;

&lt;!--- Using pagination (getting records 26-50 in this case) and a more complex way to include associations (a song `belongsTo` an album, which in turn `belongsTo` an artist) ---&gt;
&lt;cfset songs = model(&quot;song&quot;).findAll(include=&quot;album(artist)&quot;, page=2, perPage=25)&gt;

&lt;!--- Using a dynamic finder to get all books released a certain year. Same as calling model(&quot;book&quot;).findOne(where=&quot;releaseYear=#params.year#&quot;) ---&gt;
&lt;cfset books = model(&quot;book&quot;).findAllByReleaseYear(params.year)&gt;

&lt;!--- Getting all books of a certain type from a specific year by using a dynamic finder. Same as calling model(&quot;book&quot;).findAll(where=&quot;releaseYear=#params.year# AND type='#params.type#'&quot;) ---&gt;
&lt;cfset books = model(&quot;book&quot;).findAllByReleaseYearAndType(&quot;#params.year#,#params.type#&quot;)&gt;

&lt;!--- If you have a `hasMany` association setup from `post` to `comment`, you can do a scoped call. (The `comments` method below will call `model(&quot;comment&quot;).findAll(where=&quot;postId=#post.id#&quot;)` internally) ---&gt;
&lt;cfset post = model(&quot;post&quot;).findByKey(params.postId)&gt;
&lt;cfset comments = post.comments()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="findbykey" d:title="findByKey" d:parental-control="1">
		<d:index d:value="findByKey"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>findByKey()</code></h1>
	
		<h2>Description</h2>
		<p>Fetches the requested record by primary key and returns it as an object. Returns `false` if no record is found. You can override this behavior to return a `cfquery` result set instead, similar to what's described in the documentation for @findOne.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">findByKey(<em>key</em> [, <em>select</em>, <em>include</em>, <em>cache</em>, <em>reload</em>, <em>parameterize</em>, <em>returnAs</em>, <em>callbacks</em>, <em>includeSoftDeletes</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>key</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Primary key value(s) of the record to fetch. Separate with comma if passing in multiple primary key values. Accepts a string, list, or a numeric value.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>select</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Determines how the `SELECT` clause for the query used to return data will look.	You can pass in a list of the properties (which map to columns) that you want returned from your table(s). If you don't set this argument at all, Wheels will select all properties from your table(s). If you specify a table name (e.g. `users.email`) or alias a column (e.g. `fn AS firstName`) in the list, then the entire list will be passed through unchanged and used in the `SELECT` clause of the query. By default, all column names in tables `JOIN`ed via the `include` argument will be prepended with the singular version of the included table name.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>include</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>cache</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">If you want to cache the query, you can do so by specifying the number of minutes you want to cache the query for here. If you set it to `true`, the default cache time will be used (60 minutes).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>reload</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.)</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>returnAs</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>object</code></td>
				<td valign="top">Set this to `query` to return as a single-row query result set. Set this to `object` to return as an object.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>callbacks</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to disable callbacks for this operation.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>includeSoftDeletes</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">You can set this argument to `true` to include soft-deleted records in the results.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Getting the author with the primary key value `99` as an object ---&gt;
&lt;cfset auth = model(&quot;author&quot;).findByKey(99)&gt;

&lt;!--- Getting an author based on a form/URL value and then checking if it was found ---&gt;
&lt;cfset auth = model(&quot;author&quot;).findByKey(params.key)&gt;
&lt;cfif NOT IsObject(auth)&gt;
	&lt;cfset flashInsert(message=&quot;Author #params.key# was not found&quot;)&gt;
	&lt;cfset redirectTo(back=true)&gt;
&lt;/cfif&gt;

&lt;!--- If you have a `belongsTo` association setup from `comment` to `post`, you can do a scoped call. (The `post` method below will call `model(&quot;post&quot;).findByKey(comment.postId)` internally) ---&gt;
&lt;cfset comment = model(&quot;comment&quot;).findByKey(params.commentId)&gt;
&lt;cfset post = comment.post()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="findone" d:title="findOne" d:parental-control="1">
		<d:index d:value="findOne"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>findOne()</code></h1>
	
		<h2>Description</h2>
		<p>Fetches the first record found based on the `WHERE` and `ORDER BY` clauses. With the default settings (i.e. the `returnAs` argument set to `object`), a model object will be returned if the record is found and the boolean value `false` if not. Instead of using the `where` argument, you can create cleaner code by making use of a concept called dynamic finders.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">findOne([ <em>where</em>, <em>order</em>, <em>select</em>, <em>include</em>, <em>cache</em>, <em>reload</em>, <em>parameterize</em>, <em>returnAs</em>, <em>includeSoftDeletes</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>where</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `&lt;&gt;`, `&lt;`, `&lt;=`, `&gt;`, `&gt;=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>order</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Maps to the `ORDER BY` clause of the query. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>select</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Determines how the `SELECT` clause for the query used to return data will look.	You can pass in a list of the properties (which map to columns) that you want returned from your table(s). If you don't set this argument at all, Wheels will select all properties from your table(s). If you specify a table name (e.g. `users.email`) or alias a column (e.g. `fn AS firstName`) in the list, then the entire list will be passed through unchanged and used in the `SELECT` clause of the query. By default, all column names in tables `JOIN`ed via the `include` argument will be prepended with the singular version of the included table name.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>include</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>cache</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">If you want to cache the query, you can do so by specifying the number of minutes you want to cache the query for here. If you set it to `true`, the default cache time will be used (60 minutes).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>reload</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.)</td>
			</tr>
			
			<tr>
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>returnAs</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>object</code></td>
				<td valign="top">Set this to `query` to return as a single-row query result set. Set this to `object` to return as an object.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>includeSoftDeletes</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">You can set this argument to `true` to include soft-deleted records in the results.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Getting the most recent order as an object from the database ---&gt;
&lt;cfset order = model(&quot;order&quot;).findOne(order=&quot;datePurchased DESC&quot;)&gt;

&lt;!--- Using a dynamic finder to get the first person with the last name `Smith`. Same as calling `model(&quot;user&quot;).findOne(where&quot;lastName='Smith'&quot;)` ---&gt;
&lt;cfset person = model(&quot;user&quot;).findOneByLastName(&quot;Smith&quot;)&gt;

&lt;!--- Getting a specific user using a dynamic finder. Same as calling `model(&quot;user&quot;).findOne(where&quot;email='someone@somewhere.com' AND password='mypass'&quot;)` ---&gt;
&lt;cfset user = model(&quot;user&quot;).findOneByEmailAndPassword(&quot;someone@somewhere.com,mypass&quot;)&gt;

&lt;!--- If you have a `hasOne` association setup from `user` to `profile`, you can do a scoped call. (The `profile` method below will call `model(&quot;profile&quot;).findOne(where=&quot;userId=#user.id#&quot;)` internally) ---&gt;
&lt;cfset user = model(&quot;user&quot;).findByKey(params.userId)&gt;
&lt;cfset profile = user.profile()&gt;

&lt;!--- If you have a `hasMany` association setup from `post` to `comment`, you can do a scoped call. (The `findOneComment` method below will call `model(&quot;comment&quot;).findOne(where=&quot;postId=#post.id#&quot;)` internally) ---&gt;
&lt;cfset post = model(&quot;post&quot;).findByKey(params.postId)&gt;
&lt;cfset comment = post.findOneComment(where=&quot;text='I Love Wheels!'&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="flash" d:title="flash" d:parental-control="1">
		<d:index d:value="flash"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>flash()</code></h1>
	
		<h2>Description</h2>
		<p>Returns the value of a specific key in the Flash (or the entire Flash as a struct if no key is passed in).</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">flash([ <em>key</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>key</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The key to get the value for.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Display &quot;message&quot; item in flash ---&gt;
&lt;cfoutput&gt;
	&lt;cfif flashKeyExists(&quot;message&quot;)&gt;
		&lt;p class=&quot;message&quot;&gt;
			#flash(&quot;message&quot;)#
		&lt;/p&gt;
	&lt;/cfif&gt;
&lt;/cfoutput&gt;

&lt;!--- Display all flash items ---&gt;
&lt;cfoutput&gt;
	&lt;cfset allFlash = flash()&gt;
	&lt;cfloop list=&quot;#StructKeyList(allFlash)#&quot; index=&quot;flashItem&quot;&gt;
		&lt;p class=&quot;#flashItem#&quot;&gt;
			#flash(flashItem)#
		&lt;/p&gt;
	&lt;/cfloop&gt;
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="flashclear" d:title="flashClear" d:parental-control="1">
		<d:index d:value="flashClear"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>flashClear()</code></h1>
	
		<h2>Description</h2>
		<p>Deletes everything from the Flash.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">flashClear()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cfset flashClear()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="flashcount" d:title="flashCount" d:parental-control="1">
		<d:index d:value="flashCount"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>flashCount()</code></h1>
	
		<h2>Description</h2>
		<p>Returns how many keys exist in the Flash.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">flashCount()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cfif flashCount() gt 0&gt;
	do something...
&lt;/cfif&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="flashdelete" d:title="flashDelete" d:parental-control="1">
		<d:index d:value="flashDelete"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>flashDelete()</code></h1>
	
		<h2>Description</h2>
		<p>Deletes a specific key from the Flash.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">flashDelete(<em>key</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>key</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The key to delete.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cfset flashDelete(key=&quot;errorMessage&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="flashinsert" d:title="flashInsert" d:parental-control="1">
		<d:index d:value="flashInsert"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>flashInsert()</code></h1>
	
		<h2>Description</h2>
		<p>Inserts a new key/value into the Flash.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">flashInsert()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cfset flashInsert(msg=&quot;It Worked!&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="flashisempty" d:title="flashIsEmpty" d:parental-control="1">
		<d:index d:value="flashIsEmpty"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>flashIsEmpty()</code></h1>
	
		<h2>Description</h2>
		<p>Returns whether or not the Flash is empty.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">flashIsEmpty()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cfif not flashIsEmpty()&gt;
	&lt;div id=&quot;messages&quot;&gt;
		&lt;cfset allFlash = flash()&gt;
		&lt;cfloop list=&quot;#StructKeyList(allFlash)#&quot; index=&quot;flashItem&quot;&gt;
			&lt;p class=&quot;#flashItem#&quot;&gt;
				#flash(flashItem)#
			&lt;/p&gt;
		&lt;/cfloop&gt;
	&lt;/div&gt;
&lt;/cfif&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="flashkeep" d:title="flashKeep" d:parental-control="1">
		<d:index d:value="flashKeep"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>flashKeep()</code></h1>
	
		<h2>Description</h2>
		<p>Make the entire Flash or specific key in it stick around for one more request.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">flashKeep([ <em>key</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>key</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">A key or list of keys to flag for keeping. This argument is also aliased as `keys`.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Keep the entire Flash for the next request ---&gt;
&lt;cfset flashKeep()&gt;

&lt;!--- Keep the &quot;error&quot; key in the Flash for the next request ---&gt;
&lt;cfset flashKeep(&quot;error&quot;)&gt;

&lt;!--- Keep both the &quot;error&quot; and &quot;success&quot; keys in the Flash for the next request ---&gt;
&lt;cfset flashKeep(&quot;error,success&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="flashkeyexists" d:title="flashKeyExists" d:parental-control="1">
		<d:index d:value="flashKeyExists"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>flashKeyExists()</code></h1>
	
		<h2>Description</h2>
		<p>Checks if a specific key exists in the Flash.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">flashKeyExists(<em>key</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>key</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The key to check if it exists.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cfif flashKeyExists(&quot;error&quot;)&gt;
	&lt;cfoutput&gt;
		&lt;p&gt;#flash(&quot;error&quot;)#&lt;/p&gt;
	&lt;/cfoutput&gt;
&lt;/cfif&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="flashmessages" d:title="flashMessages" d:parental-control="1">
		<d:index d:value="flashMessages"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>flashMessages()</code></h1>
	
		<h2>Description</h2>
		<p>Displays a marked-up listing of messages that exists in the Flash.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">flashMessages([ <em>keys</em>, <em>class</em>, <em>includeEmptyContainer</em>, <em>lowerCaseDynamicClassValues</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>keys</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The key (or list of keys) to show the value for. You can also use the `key` argument instead for better readability when accessing a single key.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>class</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>flashMessages</code></td>
				<td valign="top">HTML `class` to set on the `div` element that contains the messages.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>includeEmptyContainer</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Includes the DIV container even if the flash is empty.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>lowerCaseDynamicClassValues</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Outputs all class attribute values in lower case (except the main one).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In the controller action ---&gt;
&lt;cfset flashInsert(success=&quot;Your post was successfully submitted.&quot;)&gt;
&lt;cfset flashInsert(alert=&quot;Don't forget to tweet about this post!&quot;)&gt;
&lt;cfset flashInsert(error=&quot;This is an error message.&quot;)&gt;

&lt;!--- In the layout or view ---&gt;
&lt;cfoutput&gt;
	#flashMessages()#
&lt;/cfoutput&gt;
&lt;!---
	Generates this (sorted alphabetically):
	&lt;div class=&quot;flashMessages&quot;&gt;
		&lt;p class=&quot;alertMessage&quot;&gt;
			Don't forget to tweet about this post!
		&lt;/p&gt;
		&lt;p class=&quot;errorMessage&quot;&gt;
			This is an error message.
		&lt;/p&gt;
		&lt;p class=&quot;successMessage&quot;&gt;
			Your post was successfully submitted.
		&lt;/p&gt;
	&lt;/div&gt;
---&gt;

&lt;!--- Only show the &quot;success&quot; key in the view ---&gt;
&lt;cfoutput&gt;
	#flashMessages(key=&quot;success&quot;)#
&lt;/cfoutput&gt;
&lt;!---
	Generates this:
	&lt;div class=&quot;flashMessage&quot;&gt;
		&lt;p class=&quot;successMessage&quot;&gt;
			Your post was successfully submitted.
		&lt;/p&gt;
	&lt;/div&gt;
---&gt;

&lt;!--- Show only the &quot;success&quot; and &quot;alert&quot; keys in the view, in that order ---&gt;
&lt;cfoutput&gt;
	#flashMessages(keys=&quot;success,alert&quot;)#
&lt;/cfoutput&gt;
&lt;!---
	Generates this (sorted alphabetically):
	&lt;div class=&quot;flashMessages&quot;&gt;
		&lt;p class=&quot;successMessage&quot;&gt;
			Your post was successfully submitted.
		&lt;/p&gt;
		&lt;p class=&quot;alertMessage&quot;&gt;
			Don't forget to tweet about this post!
		&lt;/p&gt;
	&lt;/div&gt;
---&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="get" d:title="get" d:parental-control="1">
		<d:index d:value="get"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>get()</code></h1>
	
		<h2>Description</h2>
		<p>Returns the current setting for the supplied Wheels setting or the current default for the supplied Wheels function argument.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">get(<em>name</em> [, <em>functionName</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Variable name to get setting for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>functionName</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Function name to get setting for.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get the current value for the `tableNamePrefix` Wheels setting ---&gt;
&lt;cfset setting = get(&quot;tableNamePrefix&quot;)&gt;

&lt;!--- Get the default for the `message` argument of the `validatesConfirmationOf` method  ---&gt;
&lt;cfset setting = get(functionName=&quot;validatesConfirmationOf&quot;, name=&quot;message&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="gettablenameprefix" d:title="getTableNamePrefix" d:parental-control="1">
		<d:index d:value="getTableNamePrefix"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>getTableNamePrefix()</code></h1>
	
		<h2>Description</h2>
		<p>Returns the table name prefix set for the table.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">getTableNamePrefix()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get the table name prefix for this user when running a custom query ---&gt;
&lt;cffunction name=&quot;getDisabledUsers&quot; returntype=&quot;query&quot;&gt;
	&lt;cfset var loc = {}&gt;
	&lt;cfquery datasource=&quot;#get('dataSourceName')#&quot; name=&quot;loc.disabledUsers&quot;&gt;
		SELECT
			*
		FROM
			#this.getTableNamePrefix()#users
		WHERE
			disabled = 1
	&lt;/cfquery&gt;
	&lt;cfreturn loc.disabledUsers&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="haschanged" d:title="hasChanged" d:parental-control="1">
		<d:index d:value="hasChanged"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>hasChanged()</code></h1>
	
		<h2>Description</h2>
		<p>Returns `true` if the specified property (or any if none was passed in) has been changed but not yet saved to the database. Will also return `true` if the object is new and no record for it exists in the database.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">hasChanged([ <em>property</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of property to check for change.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get a member object and change the `email` property on it ---&gt;
&lt;cfset member = model(&quot;member&quot;).findByKey(params.memberId)&gt;
&lt;cfset member.email = params.newEmail&gt;

&lt;!--- Check if the `email` property has changed ---&gt;
&lt;cfif member.hasChanged(&quot;email&quot;)&gt;
	&lt;!--- Do something... ---&gt;
&lt;/cfif&gt;

&lt;!--- The above can also be done using a dynamic function like this ---&gt;
&lt;cfif member.emailHasChanged()&gt;
	&lt;!--- Do something... ---&gt;
&lt;/cfif&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="haserrors" d:title="hasErrors" d:parental-control="1">
		<d:index d:value="hasErrors"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>hasErrors()</code></h1>
	
		<h2>Description</h2>
		<p>Returns `true` if the object has any errors. You can also limit to only check a specific property or name for errors.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">hasErrors([ <em>property</em>, <em>name</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the property to check if there are any errors set on.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Error name to check if there are any errors set with.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Check if the post object has any errors set on it ---&gt;
&lt;cfif post.hasErrors()&gt;
	&lt;!--- Send user to a form to correct the errors... ---&gt;
&lt;/cfif&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="hasmany" d:title="hasMany" d:parental-control="1">
		<d:index d:value="hasMany"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>hasMany()</code></h1>
	
		<h2>Description</h2>
		<p>Sets up a `hasMany` association between this model and the specified one.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">hasMany(<em>name</em> [, <em>modelName</em>, <em>foreignKey</em>, <em>joinType</em>, <em>dependent</em>, <em>shortcut</em>, <em>through</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Gives the association a name that you refer to when working with the association (in the `include` argument to @findAll, to name one example).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>modelName</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of associated model (usually not needed if you follow Wheels conventions because the model name will be deduced from the `name` argument).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>foreignKey</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Foreign key property name (usually not needed if you follow Wheels conventions since the foreign key name will be deduced from the `name` argument).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>joinType</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>outer</code></td>
				<td valign="top">Use to set the join type when joining associated tables. Possible values are `inner` (for `INNER JOIN`) and `outer` (for `LEFT OUTER JOIN`).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>dependent</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Defines how to handle dependent models when you delete a record from this model. Set to `delete` to instantiate associated models and call their @delete method, `deleteAll` to delete without instantiating, `nullify` to remove the foreign key, or `false` to do nothing.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>shortcut</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set this argument to create an additional dynamic method that gets the object(s) from the other side of a many-to-many association.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>through</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Set this argument if you need to override Wheels conventions when using the `shortcut` argument. Accepts a list of two association names representing the chain from the opposite side of the many-to-many relationship to this model.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!---
	Example1: Specify that instances of this model has many comments.
	(The table for the associated model, not the current, should have the foreign key set on it.)
---&gt;
&lt;cfset hasMany(&quot;comments&quot;)&gt;

&lt;!---
	Example 2: Specify that this model (let's call it `reader` in this case) has many subscriptions and setup a shortcut to the `publication` model.
	(Useful when dealing with many-to-many relationships.)
---&gt;
&lt;cfset hasMany(name=&quot;subscriptions&quot;, shortcut=&quot;publications&quot;)&gt;

&lt;!--- Example 3: Automatically delete all associated `comments` whenever this object is deleted ---&gt;
&lt;cfset hasMany(name=&quot;comments&quot;, dependent=&quot;deleteAll&quot;)&gt;

&lt;!---
	Example 4: When not following Wheels naming conventions for associations, it can get complex to define how a `shortcut` works.
	In this example, we are naming our `shortcut` differently than the actual model's name.
---&gt;
&lt;!--- In the models/Customer.cfc `init()` method ---&gt;
&lt;cfset hasMany(name=&quot;subscriptions&quot;, shortcut=&quot;magazines&quot;, through=&quot;publication,subscriptions&quot;)&gt;

&lt;!--- In the models/Subscriptions.cfc `init()` method ---&gt;
&lt;cfset belongsTo(&quot;customer&quot;)&gt;
&lt;cfset belongsTo(&quot;publication&quot;)&gt;

&lt;!--- In the models/Publication `init()` method ---&gt;
&lt;cfset hasMany(&quot;subscriptions&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="hasmanycheckbox" d:title="hasManyCheckBox" d:parental-control="1">
		<d:index d:value="hasManyCheckBox"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>hasManyCheckBox()</code></h1>
	
		<h2>Description</h2>
		<p>Used as a shortcut to output the proper form elements for an association. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">hasManyCheckBox(<em>objectName</em>, <em>association</em>, <em>keys</em> [, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em>, <em>errorElement</em>, <em>errorClass</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>objectName</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the variable containing the parent object to represent with this form field.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>association</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the association set in the parent object to represent with this form field.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>keys</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Primary keys associated with this form field.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>errorElement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">HTML tag to wrap the form control with when the object contains errors.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>errorClass</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The class name of the HTML tag that wraps the form control when there are errors.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Show check boxes for associating authors with the current book ---&gt;
&lt;cfloop query=&quot;authors&quot;&gt;
	#hasManyCheckBox(
		label=authors.fullName,
		objectName=&quot;book&quot;,
		association=&quot;bookAuthors&quot;,
		keys=&quot;#book.key()#,#authors.id#&quot;
	)#
&lt;/cfloop&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="hasmanyradiobutton" d:title="hasManyRadioButton" d:parental-control="1">
		<d:index d:value="hasManyRadioButton"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>hasManyRadioButton()</code></h1>
	
		<h2>Description</h2>
		<p>Used as a shortcut to output the proper form elements for an association. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">hasManyRadioButton(<em>objectName</em>, <em>association</em>, <em>property</em>, <em>keys</em>, <em>tagValue</em> [, <em>checkIfBlank</em>, <em>label</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>objectName</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the variable containing the parent object to represent with this form field.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>association</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the association set in the parent object to represent with this form field.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the property in the child object to represent with this form field.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>keys</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Primary keys associated with this form field.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>tagValue</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The value of the radio button when `selected`.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>checkIfBlank</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether or not to check this form field as a default if there is a blank value set for the property.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Show radio buttons for associating a default address with the current author ---&gt;
&lt;cfloop query=&quot;addresses&quot;&gt;
	#hasManyRadioButton(
		label=addresses.title,
		objectName=&quot;author&quot;,
		association=&quot;authorsDefaultAddresses&quot;,
		keys=&quot;#author.key()#,#addresses.id#&quot;
	)#
&lt;/cfloop&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="hasone" d:title="hasOne" d:parental-control="1">
		<d:index d:value="hasOne"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>hasOne()</code></h1>
	
		<h2>Description</h2>
		<p>Sets up a `hasOne` association between this model and the specified one.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">hasOne(<em>name</em> [, <em>modelName</em>, <em>foreignKey</em>, <em>joinType</em>, <em>dependent</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Gives the association a name that you refer to when working with the association (in the `include` argument to @findAll, to name one example).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>modelName</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of associated model (usually not needed if you follow Wheels conventions because the model name will be deduced from the `name` argument).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>foreignKey</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Foreign key property name (usually not needed if you follow Wheels conventions since the foreign key name will be deduced from the `name` argument).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>joinType</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>outer</code></td>
				<td valign="top">Use to set the join type when joining associated tables. Possible values are `inner` (for `INNER JOIN`) and `outer` (for `LEFT OUTER JOIN`).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>dependent</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Defines how to handle dependent models when you delete a record from this model. Set to `delete` to instantiate associated models and call their @delete method, `deleteAll` to delete without instantiating, `nullify` to remove the foreign key, or `false` to do nothing.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Specify that instances of this model has one profile. (The table for the associated model, not the current, should have the foreign key set on it.) ---&gt;
&lt;cfset hasOne(&quot;profile&quot;)&gt;

&lt;!--- Same as above but setting the `joinType` to `inner`, which basically means this model should always have a record in the `profiles` table ---&gt;
&lt;cfset hasOne(name=&quot;profile&quot;, joinType=&quot;inner&quot;)&gt;

&lt;!--- Automatically delete the associated `profile` whenever this object is deleted ---&gt;
&lt;cfset hasMany(name=&quot;comments&quot;, dependent=&quot;delete&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="hasproperty" d:title="hasProperty" d:parental-control="1">
		<d:index d:value="hasProperty"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>hasProperty()</code></h1>
	
		<h2>Description</h2>
		<p>Returns `true` if the specified property name exists on the model.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">hasProperty(<em>property</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of property to inspect.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get an object, set a value and then see if the property exists ---&gt;
&lt;cfset employee = model(&quot;employee&quot;).new()&gt;
&lt;cfset employee.firstName = &quot;dude&quot;&gt;
&lt;cfset employee.hasProperty(&quot;firstName&quot;)&gt;&lt;!--- returns true ---&gt;

&lt;!--- This is also a dynamic method that you could do ---&gt;
&lt;cfset employee.hasFirstName()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="hiddenfield" d:title="hiddenField" d:parental-control="1">
		<d:index d:value="hiddenField"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>hiddenField()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a hidden field form control based on the supplied `objectName` and `property`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">hiddenField(<em>objectName</em>, <em>property</em> [, <em>association</em>, <em>position</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>objectName</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The variable name of the object to build the form control for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the property to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>association</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>position</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Provide an `objectName` and `property` ---&gt;
&lt;cfoutput&gt;
    #hiddenField(objectName=&quot;user&quot;, property=&quot;id&quot;)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="hiddenfieldtag" d:title="hiddenFieldTag" d:parental-control="1">
		<d:index d:value="hiddenFieldTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>hiddenFieldTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a hidden field form control based on the supplied `name`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">hiddenFieldTag(<em>name</em> [, <em>value</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>value</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Value to populate in tag's `value` attribute.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Basic usage usually involves a `name` and `value` ---&gt;
&lt;cfoutput&gt;
    #hiddenFieldTag(name=&quot;userId&quot;, value=user.id)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="highlight" d:title="highlight" d:parental-control="1">
		<d:index d:value="highlight"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>highlight()</code></h1>
	
		<h2>Description</h2>
		<p>Highlights the phrase(s) everywhere in the text if found by wrapping it in a `span` tag.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">highlight(<em>text</em>, <em>phrases</em> [, <em>class</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>text</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Text to search.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>phrases</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">List of phrases to highlight.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>class</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>highlight</code></td>
				<td valign="top">Class to use in `span` tags surrounding highlighted phrase(s).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>#highlight(text=&quot;You searched for: Wheels&quot;, phrases=&quot;Wheels&quot;)#
-&gt; You searched for: &lt;span class=&quot;highlight&quot;&gt;Wheels&lt;/span&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="hourselecttag" d:title="hourSelectTag" d:parental-control="1">
		<d:index d:value="hourSelectTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>hourSelectTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing one select form control for the hours of the day based on the supplied `name`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">hourSelectTag(<em>name</em> [, <em>selected</em>, <em>includeBlank</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em>, <em>twelveHour</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>selected</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The hour that should be selected initially.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>includeBlank</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, &quot;- Select One -&quot;).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>twelveHour</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- This &quot;Tag&quot; version of the function accepts a `name` and `selected` instead of binding to a model object ---&gt;
&lt;cfoutput&gt;
    #hourSelectTag(name=&quot;hourOfMeeting&quot;, selected=params.hourOfMeeting)#
&lt;/cfoutput&gt;

&lt;!--- Show 12 hours instead of 24 ---&gt;
&lt;cfoutput&gt;
	#hourSelectTag(name=&quot;hourOfMeeting&quot;, selected=params.hourOfMeeting, twelveHour=true)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="humanize" d:title="humanize" d:parental-control="1">
		<d:index d:value="humanize"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>humanize()</code></h1>
	
		<h2>Description</h2>
		<p>Returns readable text by capitalizing and converting camel casing to multiple words.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">humanize(<em>text</em> [, <em>except</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>text</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Text to humanize.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>except</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">a list of strings (space separated) to replace within the output.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Humanize a string, will result in &quot;Wheels Is A Framework&quot; ---&gt;
#humanize(&quot;wheelsIsAFramework&quot;)#

&lt;!--- Humanize a string, force wheels to replace &quot;Cfml&quot; with &quot;CFML&quot; ---&gt;
#humanize(&quot;wheelsIsACFMLFramework&quot;, &quot;CFML&quot;)#</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="hyphenize" d:title="hyphenize" d:parental-control="1">
		<d:index d:value="hyphenize"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>hyphenize()</code></h1>
	
		<h2>Description</h2>
		<p>Converts camelCase strings to lowercase strings with hyphens as word delimiters instead. Example: `myVariable` becomes `my-variable`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">hyphenize(<em>string</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>string</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The string to hyphenize.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Outputs &quot;my-blog-post&quot; ---&gt;
&lt;cfoutput&gt;
	#hyphenize(&quot;myBlogPost&quot;)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="imagetag" d:title="imageTag" d:parental-control="1">
		<d:index d:value="imageTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>imageTag()</code></h1>
	
		<h2>Description</h2>
		<p>Returns an `img` tag. If the image is stored in the local `images` folder, the tag will also set the `width`, `height`, and `alt` attributes for you. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">imageTag(<em>source</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>source</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The file name of the image if it's availabe in the local file system (i.e. ColdFusion will be able to access it). Provide the full URL if the image is on a remote server.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Outputs an `img` tag for `images/logo.png` ---&gt;
#imageTag(&quot;logo.png&quot;)#

&lt;!--- Outputs an `img` tag for `http://cfwheels.org/images/logo.png` ---&gt;
#imageTag(&quot;http://cfwheels.org/images/logo.png&quot;, alt=&quot;ColdFusion on Wheels&quot;)#

&lt;!--- Outputs an `img` tag with the `class` attribute set ---&gt;
#imageTag(source=&quot;logo.png&quot;, class=&quot;logo&quot;)#</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="includecontent" d:title="includeContent" d:parental-control="1">
		<d:index d:value="includeContent"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>includeContent()</code></h1>
	
		<h2>Description</h2>
		<p>Used to output the content for a particular section in a layout.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">includeContent([ <em>name</em>, <em>default</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>body</code></td>
				<td valign="top">Name of layout section to return content for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>default</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">What to display as a default if the section is not defined.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In your view template, let's say `views/blog/post.cfm ---&gt;
&lt;cfset contentFor(head='&lt;meta name=&quot;robots&quot; content=&quot;noindex,nofollow&quot; /&gt;&quot;')&gt;
&lt;cfset contentFor(head='&lt;meta name=&quot;author&quot; content=&quot;wheelsdude@wheelsify.com&quot;')&gt;

&lt;!--- In `views/layout.cfm` ---&gt;
&lt;html&gt;
&lt;head&gt;
    &lt;title&gt;My Site&lt;/title&gt;
    #includeContent(&quot;head&quot;)#
&lt;/head&gt;
&lt;body&gt;

&lt;cfoutput&gt;
#includeContent()#
&lt;/cfoutput&gt;

&lt;/body&gt;
&lt;/html&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="includedinobject" d:title="includedInObject" d:parental-control="1">
		<d:index d:value="includedInObject"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>includedInObject()</code></h1>
	
		<h2>Description</h2>
		<p>Used as a shortcut to check if the specified IDs are a part of the main form object. This method should only be used for `hasMany` associations.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">includedInObject(<em>objectName</em>, <em>association</em>, <em>keys</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>objectName</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the variable containing the parent object to represent with this form field.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>association</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the association set in the parent object to represent with this form field.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>keys</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Primary keys associated with this form field.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Check to see if the customer is subscribed to the Swimsuit Edition. Note that the order of the `keys` argument should match the order of the `customerid` and `publicationid` columns in the `subscriptions` join table ---&gt;
&lt;cfif not includedInObject(objectName=&quot;customer&quot;, association=&quot;subscriptions&quot;, keys=&quot;#customer.key()#,#swimsuitEdition.id#&quot;)&gt;
	&lt;cfset assignSalesman(customer)&gt;
&lt;/cfif&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="includelayout" d:title="includeLayout" d:parental-control="1">
		<d:index d:value="includeLayout"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>includeLayout()</code></h1>
	
		<h2>Description</h2>
		<p>Includes the contents of another layout file. This is usually used to include a parent layout from within a child layout.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">includeLayout([ <em>name</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>layout</code></td>
				<td valign="top">Name of the layout file to include.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Make sure that the `sidebar` value is provided for the parent layout ---&gt;
&lt;cfsavecontent variable=&quot;categoriesSidebar&quot;&gt;
	&lt;cfoutput&gt;
		&lt;ul&gt;
			#includePartial(categories)#
		&lt;/ul&gt;
	&lt;/cfoutput&gt;
&lt;/cfsavecontent&gt;
&lt;cfset contentFor(sidebar=categoriesSidebar)&gt;

&lt;!--- Include parent layout at `views/layout.cfm` ---&gt;
&lt;cfoutput&gt;
	#includeLayout(&quot;/layout.cfm&quot;)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="includepartial" d:title="includePartial" d:parental-control="1">
		<d:index d:value="includePartial"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>includePartial()</code></h1>
	
		<h2>Description</h2>
		<p>Includes the specified partial file in the view. Similar to using `cfinclude` but with the ability to cache the result and use Wheels-specific file look-up. By default, Wheels will look for the file in the current controller's view folder. To include a file relative from the base `views` folder, you can start the path supplied to `name` with a forward slash.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">includePartial(<em>partial</em> [, <em>group</em>, <em>cache</em>, <em>layout</em>, <em>spacer</em>, <em>dataFunction</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>partial</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the partial file to be used. Prefix with a leading slash `/` if you need to build a path from the root `views` folder. Do not include the partial filename's underscore and file extension.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>group</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">If passing a query result set for the `partial` argument, use this to specify the field to group the query by. A new query will be passed into the partial template for you to iterate over.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>cache</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Number of minutes to cache the content for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>layout</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The layout to wrap the content in. Prefix with a leading slash `/` if you need to build a path from the root `views` folder. Pass `false` to not load a layout at all.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>spacer</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">HTML or string to place between partials when called using a query.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>dataFunction</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Name of controller function to load data from.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cfoutput&gt;#includePartial(&quot;login&quot;)#&lt;/cfoutput&gt;
-&gt; If we're in the &quot;admin&quot; controller, Wheels will include the file &quot;views/admin/_login.cfm&quot;.

&lt;cfoutput&gt;#includePartial(partial=&quot;misc/doc&quot;, cache=30)#&lt;/cfoutput&gt;
-&gt; If we're in the &quot;admin&quot; controller, Wheels will include the file &quot;views/admin/misc/_doc.cfm&quot; and cache it for 30 minutes.

&lt;cfoutput&gt;#includePartial(partial=&quot;/shared/button&quot;)#&lt;/cfoutput&gt;
-&gt; Wheels will include the file &quot;views/shared/_button.cfm&quot;.</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="invokewithtransaction" d:title="invokeWithTransaction" d:parental-control="1">
		<d:index d:value="invokeWithTransaction"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>invokeWithTransaction()</code></h1>
	
		<h2>Description</h2>
		<p>Runs the specified method within a single database transaction.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">invokeWithTransaction(<em>method</em> [, <em>transaction</em>, <em>isolation</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>method</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Model method to run.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>transaction</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>commit</code></td>
				<td valign="top">Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>isolation</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>read_committed</code></td>
				<td valign="top">Isolation level to be passed through to the `cftransaction` tag. See your CFML engine's documentation for more details about `cftransaction`'s `isolation` attribute.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- This is the method to be run inside a transaction ---&gt;
&lt;cffunction name=&quot;tranferFunds&quot; returntype=&quot;boolean&quot; output=&quot;false&quot;&gt;
	&lt;cfargument name=&quot;personFrom&quot;&gt;
	&lt;cfargument name=&quot;personTo&quot;&gt;
	&lt;cfargument name=&quot;amount&quot;&gt;
	&lt;cfif arguments.personFrom.withdraw(arguments.amount) and arguments.personTo.deposit(arguments.amount)&gt;
		&lt;cfreturn true&gt;
	&lt;cfelse&gt;
		&lt;cfreturn false&gt;
	&lt;/cfif&gt;
&lt;/cffunction&gt;

&lt;cfset david = model(&quot;Person&quot;).findOneByName(&quot;David&quot;)&gt;
&lt;cfset mary = model(&quot;Person&quot;).findOneByName(&quot;Mary&quot;)&gt;
&lt;cfset invokeWithTransaction(method=&quot;transferFunds&quot;, personFrom=david, personTo=mary, amount=100)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="isajax" d:title="isAjax" d:parental-control="1">
		<d:index d:value="isAjax"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>isAjax()</code></h1>
	
		<h2>Description</h2>
		<p>Returns whether the page was called from JavaScript or not.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">isAjax()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cfset requestIsAjax = isAjax()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="isclass" d:title="isClass" d:parental-control="1">
		<d:index d:value="isClass"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>isClass()</code></h1>
	
		<h2>Description</h2>
		<p>Use this method within a model's method to check whether you are currently in a class-level object.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">isClass()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Use the passed in `id` when we're already in an instance ---&gt;
&lt;cffunction name=&quot;memberIsAdmin&quot;&gt;
	&lt;cfif isClass()&gt;
		&lt;cfreturn this.findByKey(arguments.id).admin&gt;
	&lt;cfelse&gt;
		&lt;cfreturn this.admin&gt;
	&lt;/cfif&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="isget" d:title="isGet" d:parental-control="1">
		<d:index d:value="isGet"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>isGet()</code></h1>
	
		<h2>Description</h2>
		<p>Returns whether the request was a normal `GET` request or not.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">isGet()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cfset requestIsGet = isGet()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="isinstance" d:title="isInstance" d:parental-control="1">
		<d:index d:value="isInstance"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>isInstance()</code></h1>
	
		<h2>Description</h2>
		<p>Use this method to check whether you are currently in an instance object.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">isInstance()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Use the passed in `id` when we're not already in an instance ---&gt;
&lt;cffunction name=&quot;memberIsAdmin&quot;&gt;
	&lt;cfif isInstance()&gt;
		&lt;cfreturn this.admin&gt;
	&lt;cfelse&gt;
		&lt;cfreturn this.findByKey(arguments.id).admin&gt;
	&lt;/cfif&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="isnew" d:title="isNew" d:parental-control="1">
		<d:index d:value="isNew"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>isNew()</code></h1>
	
		<h2>Description</h2>
		<p>Returns `true` if this object hasn't been saved yet. (In other words, no matching record exists in the database yet.) Returns `false` if a record exists.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">isNew()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Create a new object and then check if it is new (yes, this example is ridiculous. It makes more sense in the context of callbacks for example) ---&gt;
&lt;cfset employee = model(&quot;employee&quot;).new()&gt;
&lt;cfif employee.isNew()&gt;
	&lt;!--- Do something... ---&gt;
&lt;/cfif&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="ispost" d:title="isPost" d:parental-control="1">
		<d:index d:value="isPost"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>isPost()</code></h1>
	
		<h2>Description</h2>
		<p>Returns whether the request came from a form `POST` submission or not.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">isPost()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cfset requestIsPost = isPost()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="issecure" d:title="isSecure" d:parental-control="1">
		<d:index d:value="isSecure"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>isSecure()</code></h1>
	
		<h2>Description</h2>
		<p>Returns whether Wheels is communicating over a secure port.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">isSecure()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Redirect non-secure connections to the secure version ---&gt;
&lt;cfif not isSecure()&gt;
	&lt;cfset redirectTo(protocol=&quot;https&quot;)&gt;
&lt;/cfif&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="javascriptincludetag" d:title="javaScriptIncludeTag" d:parental-control="1">
		<d:index d:value="javaScriptIncludeTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>javaScriptIncludeTag()</code></h1>
	
		<h2>Description</h2>
		<p>Returns a `script` tag for a JavaScript file (or several) based on the supplied arguments.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">javaScriptIncludeTag([ <em>sources</em>, <em>type</em>, <em>head</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>sources</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of one or many JavaScript files in the `javascripts` folder, minus the `.js` extension. (Can also be called with the `source` argument.)</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>type</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>text/javascript</code></td>
				<td valign="top">The `type` attribute for the `script` tag.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>head</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to place the output in the `head` area of the HTML page instead of the default behavior, which is to place the output where the function is called from.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- view code ---&gt;
&lt;head&gt;
	&lt;!--- Includes `javascripts/main.js` ---&gt;
    #javaScriptIncludeTag(&quot;main&quot;)#
	&lt;!--- Includes `javascripts/blog.js` and `javascripts/accordion.js` ---&gt;
	#javaScriptIncludeTag(&quot;blog,accordion&quot;)#
&lt;/head&gt;

&lt;body&gt;
	&lt;!--- Will still appear in the `head` ---&gt;
	#javaScriptIncludeTag(source=&quot;tabs&quot;, head=true)#
&lt;/body&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="key" d:title="key" d:parental-control="1">
		<d:index d:value="key"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>key()</code></h1>
	
		<h2>Description</h2>
		<p>Returns the value of the primary key for the object. If you have a single primary key named `id`, then `someObject.key()` is functionally equivalent to `someObject.id`. This method is more useful when you do dynamic programming and don't know the name of the primary key or when you use composite keys (in which case it's convenient to use this method to get a list of both key values returned).</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">key()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get an object and then get the primary key value(s) ---&gt;
&lt;cfset employee = model(&quot;employee&quot;).findByKey(params.key)&gt;
&lt;cfset val = employee.key()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="linkto" d:title="linkTo" d:parental-control="1">
		<d:index d:value="linkTo"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>linkTo()</code></h1>
	
		<h2>Description</h2>
		<p>Creates a link to another page in your application. Pass in the name of a `route` to use your configured routes or a `controller`/`action`/`key` combination. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">linkTo([ <em>text</em>, <em>confirm</em>, <em>route</em>, <em>controller</em>, <em>action</em>, <em>key</em>, <em>params</em>, <em>anchor</em>, <em>onlyPath</em>, <em>host</em>, <em>protocol</em>, <em>port</em>, <em>href</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>text</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The text content of the link.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>confirm</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Pass a message here to cause a JavaScript confirmation dialog box to pop up containing the message.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>route</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of a route that you have configured in `config/routes.cfm`.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>controller</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the controller to include in the URL.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>action</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the action to include in the URL.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>key</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Key(s) to include in the URL.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>params</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Any additional params to be set in the query string.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>anchor</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Sets an anchor name to be appended to the path.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>onlyPath</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">If `true`, returns only the relative URL (no protocol, host name or port).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>host</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set this to override the current host.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>protocol</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set this to override the current protocol.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>port</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>0</code></td>
				<td valign="top">Set this to override the current port number.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>href</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Pass a link to an external site here if you want to bypass the Wheels routing system altogether and link to an external URL.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>#linkTo(text=&quot;Log Out&quot;, controller=&quot;account&quot;, action=&quot;logout&quot;)#
-&gt; &lt;a href=&quot;/account/logout&quot;&gt;Log Out&lt;/a&gt;

&lt;!--- if you're already in the `account` controller, Wheels will assume that's where you want the link to point ---&gt;
#linkTo(text=&quot;Log Out&quot;, action=&quot;logout&quot;)#
-&gt; &lt;a href=&quot;/account/logout&quot;&gt;Log Out&lt;/a&gt;

#linkTo(text=&quot;View Post&quot;, controller=&quot;blog&quot;, action=&quot;post&quot;, key=99)#
-&gt; &lt;a href=&quot;/blog/post/99&quot;&gt;View Post&lt;/a&gt;

#linkTo(text=&quot;View Settings&quot;, action=&quot;settings&quot;, params=&quot;show=all&amp;sort=asc&quot;)#
-&gt; &lt;a href=&quot;/account/settings?show=all&amp;amp;sort=asc&quot;&gt;View Settings&lt;/a&gt;

&lt;!--- Given that a `userProfile` route has been configured in `config/routes.cfm` ---&gt;
#linkTo(text=&quot;Joe's Profile&quot;, route=&quot;userProfile&quot;, userName=&quot;joe&quot;)#
-&gt; &lt;a href=&quot;/user/joe&quot;&gt;Joe's Profile&lt;/a&gt;

&lt;!--- Link to an external website ---&gt;
#linkTo(text=&quot;ColdFusion Framework&quot;, href=&quot;http://cfwheels.org/&quot;)#
-&gt; &lt;a href=&quot;http://cfwheels.org/&quot;&gt;ColdFusion Framework&lt;/a&gt;

&lt;!--- Give the link `class` and `id` attributes ---&gt;
#linkTo(text=&quot;Delete Post&quot;, action=&quot;delete&quot;, key=99, class=&quot;delete&quot;, id=&quot;delete-99&quot;)#
-&gt; &lt;a class=&quot;delete&quot; href=&quot;/blog/delete/99&quot; id=&quot;delete-99&quot;&gt;Delete Post&lt;/a&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="mailto" d:title="mailTo" d:parental-control="1">
		<d:index d:value="mailTo"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>mailTo()</code></h1>
	
		<h2>Description</h2>
		<p>Creates a `mailto` link tag to the specified email address, which is also used as the name of the link unless name is specified.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">mailTo(<em>emailAddress</em> [, <em>name</em>, <em>encode</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>emailAddress</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The email address to link to.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">A string to use as the link text (&quot;Joe&quot; or &quot;Support Department&quot;, for example).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>encode</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Pass `true` here to encode the email address, making it harder for bots to harvest it for example.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>#mailTo(emailAddress=&quot;webmaster@yourdomain.com&quot;, name=&quot;Contact our Webmaster&quot;)#
-&gt; &lt;a href=&quot;mailto:webmaster@yourdomain.com&quot;&gt;Contact our Webmaster&lt;/a&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="maximum" d:title="maximum" d:parental-control="1">
		<d:index d:value="maximum"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>maximum()</code></h1>
	
		<h2>Description</h2>
		<p>Calculates the maximum value for a given property. Uses the SQL function `MAX`. If no records can be found to perform the calculation on you can use the `ifNull` argument to decide what should be returned.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">maximum(<em>property</em> [, <em>where</em>, <em>include</em>, <em>parameterize</em>, <em>ifNull</em>, <em>includeSoftDeletes</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the property to get the highest value for (must be a property of a numeric data type).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>where</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `&lt;&gt;`, `&lt;`, `&lt;=`, `&gt;`, `&gt;=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>include</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>ifNull</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The value returned if no records are found. Common usage is to set this to `0` to make sure a numeric value is always returned instead of a blank string.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeSoftDeletes</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">You can set this argument to `true` to include soft-deleted records in the results.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get the amount of the highest salary for all employees ---&gt;
&lt;cfset highestSalary = model(&quot;employee&quot;).maximum(&quot;salary&quot;)&gt;

&lt;!--- Get the amount of the highest salary for employees in a given department ---&gt;
&lt;cfset highestSalary = model(&quot;employee&quot;).maximum(property=&quot;salary&quot;, where=&quot;departmentId=#params.key#&quot;)&gt;

&lt;!--- Make sure a numeric value is always returned, even if no records are found to calculate the maximum for ---&gt;
&lt;cfset highestSalary = model(&quot;employee&quot;).maximum(property=&quot;salary&quot;, where=&quot;salary &gt; #params.minSalary#&quot;, ifNull=0)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="mimetypes" d:title="mimeTypes" d:parental-control="1">
		<d:index d:value="mimeTypes"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>mimeTypes()</code></h1>
	
		<h2>Description</h2>
		<p>Returns an associated MIME type based on a file extension.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">mimeTypes(<em>extension</em> [, <em>fallback</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>extension</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The extension to get the MIME type for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>fallback</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>application/octet-stream</code></td>
				<td valign="top">the fallback MIME type to return.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get the internally-stored MIME type for `xls` ---&gt;
&lt;cfset mimeType = mimeTypes(&quot;xls&quot;)&gt;

&lt;!--- Get the internally-stored MIME type for a dynamic value. Fall back to a MIME type of `text/plain` if it's not found ---&gt;
&lt;cfset mimeType = mimeTypes(extension=params.type, fallback=&quot;text/plain&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="minimum" d:title="minimum" d:parental-control="1">
		<d:index d:value="minimum"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>minimum()</code></h1>
	
		<h2>Description</h2>
		<p>Calculates the minimum value for a given property. Uses the SQL function `MIN`. If no records can be found to perform the calculation on you can use the `ifNull` argument to decide what should be returned.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">minimum(<em>property</em> [, <em>where</em>, <em>include</em>, <em>parameterize</em>, <em>ifNull</em>, <em>includeSoftDeletes</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the property to get the lowest value for (must be a property of a numeric data type).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>where</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `&lt;&gt;`, `&lt;`, `&lt;=`, `&gt;`, `&gt;=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>include</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>ifNull</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The value returned if no records are found. Common usage is to set this to `0` to make sure a numeric value is always returned instead of a blank string.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeSoftDeletes</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">You can set this argument to `true` to include soft-deleted records in the results.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get the amount of the lowest salary for all employees ---&gt;
&lt;cfset lowestSalary = model(&quot;employee&quot;).minimum(&quot;salary&quot;)&gt;

&lt;!--- Get the amount of the lowest salary for employees in a given department ---&gt;
&lt;cfset lowestSalary = model(&quot;employee&quot;).minimum(property=&quot;salary&quot;, where=&quot;departmentId=#params.id#&quot;)&gt;

&lt;!--- Make sure a numeric amount is always returned, even when there were no records analyzed by the query ---&gt;
&lt;cfset lowestSalary = model(&quot;employee&quot;).minimum(property=&quot;salary&quot;, where=&quot;salary BETWEEN #params.min# AND #params.max#&quot;, ifNull=0)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="minuteselecttag" d:title="minuteSelectTag" d:parental-control="1">
		<d:index d:value="minuteSelectTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>minuteSelectTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing one select form control for the minutes of an hour based on the supplied `name`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">minuteSelectTag(<em>name</em> [, <em>selected</em>, <em>minuteStep</em>, <em>includeBlank</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>selected</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The minute that should be selected initially.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>minuteStep</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>1</code></td>
				<td valign="top">Pass in `10` to only show minute 10, 20, 30, etc.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeBlank</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, &quot;- Select One -&quot;).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- This &quot;Tag&quot; version of the function accepts a `name` and `selected` instead of binding to a model object ---&gt;
&lt;cfoutput&gt;
    #minuteSelectTag(name=&quot;minuteOfMeeting&quot;, value=params.minuteOfMeeting)#
&lt;/cfoutput&gt;

&lt;!--- Only show 15-minute intervals ---&gt;
&lt;cfoutput&gt;
	#minuteSelectTag(name=&quot;minuteOfMeeting&quot;, value=params.minuteOfMeeting, minuteStep=15)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="model" d:title="model" d:parental-control="1">
		<d:index d:value="model"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>model()</code></h1>
	
		<h2>Description</h2>
		<p>Returns a reference to the requested model so that class level methods can be called on it.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">model(<em>name</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the model to get a reference to.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- The `model(&quot;author&quot;)` part of the code below gets a reference to the model from the application scope, and then the `findByKey` class level method is called on it ---&gt;
&lt;cfset authorObject = model(&quot;author&quot;).findByKey(1)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="monthselecttag" d:title="monthSelectTag" d:parental-control="1">
		<d:index d:value="monthSelectTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>monthSelectTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a select form control for the months of the year based on the supplied `name`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">monthSelectTag(<em>name</em> [, <em>selected</em>, <em>monthDisplay</em>, <em>includeBlank</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>selected</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The month that should be selected initially.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>monthDisplay</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>names</code></td>
				<td valign="top">Pass in `names`, `numbers`, or `abbreviations` to control display.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeBlank</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, &quot;- Select One -&quot;).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- This &quot;Tag&quot; version of the function accepts a `name` and `selected` instead of binding to a model object ---&gt;
&lt;cfoutput&gt;
    #monthSelectTag(name=&quot;monthOfBirthday&quot;, selected=params.monthOfBirthday)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="nestedproperties" d:title="nestedProperties" d:parental-control="1">
		<d:index d:value="nestedProperties"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>nestedProperties()</code></h1>
	
		<h2>Description</h2>
		<p>Allows for nested objects, structs, and arrays to be set from params and other generated data.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">nestedProperties([ <em>association</em>, <em>autoSave</em>, <em>allowDelete</em>, <em>sortProperty</em>, <em>rejectIfBlank</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>association</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The association (or list of associations) you want to allow to be set through the params. This argument is also aliased as `associations`.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>autoSave</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Whether to save the association(s) when the parent object is saved.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>allowDelete</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set `allowDelete` to `true` to tell Wheels to look for the property `_delete` in your model. If present and set to a value that evaluates to `true`, the model will be deleted when saving the parent.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>sortProperty</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set `sortProperty` to a property on the object that you would like to sort by. The property should be numeric, should start with 1, and should be consecutive. Only valid with `hasMany` associations.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>rejectIfBlank</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">A list of properties that should not be blank. If any of the properties are blank, any CRUD operations will be rejected.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In `models/User.cfc`, allow for `groupEntitlements` to be saved and deleted through the `user` object ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;cfset hasMany(&quot;groupEntitlements&quot;)&gt;
	&lt;cfset nestedProperties(association=&quot;groupEntitlements&quot;, allowDelete=true)&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="new" d:title="new" d:parental-control="1">
		<d:index d:value="new"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>new()</code></h1>
	
		<h2>Description</h2>
		<p>Creates a new object based on supplied properties and returns it. The object is not saved to the database; it only exists in memory. Property names and values can be passed in either using named arguments or as a struct to the `properties` argument.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">new([ <em>properties</em>, <em>callbacks</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>struct</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">The properties you want to set on the object (can also be passed in as named arguments).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>callbacks</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to disable callbacks for this operation.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Create a new author in memory (not saved to the database) ---&gt;
&lt;cfset newAuthor = model(&quot;author&quot;).new()&gt;

&lt;!--- Create a new author based on properties in a struct ---&gt;
&lt;cfset newAuthor = model(&quot;author&quot;).new(params.authorStruct)&gt;

&lt;!--- Create a new author by passing in named arguments ---&gt;
&lt;cfset newAuthor = model(&quot;author&quot;).new(firstName=&quot;John&quot;, lastName=&quot;Doe&quot;)&gt;

&lt;!--- If you have a `hasOne` or `hasMany` association setup from `customer` to `order`, you can do a scoped call. (The `newOrder` method below will call `model(&quot;order&quot;).new(customerId=aCustomer.id)` internally.) ---&gt;
&lt;cfset aCustomer = model(&quot;customer&quot;).findByKey(params.customerId)&gt;
&lt;cfset anOrder = aCustomer.newOrder(shipping=params.shipping)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="obfuscateparam" d:title="obfuscateParam" d:parental-control="1">
		<d:index d:value="obfuscateParam"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>obfuscateParam()</code></h1>
	
		<h2>Description</h2>
		<p>Obfuscates a value. Typically used for hiding primary key values when passed along in the URL.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">obfuscateParam(<em>param</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>param</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Value to obfuscate.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Obfuscate the primary key value `99` ---&gt;
&lt;cfset newValue = obfuscateParam(99)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="onlyprovides" d:title="onlyProvides" d:parental-control="1">
		<d:index d:value="onlyProvides"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>onlyProvides()</code></h1>
	
		<h2>Description</h2>
		<p>Use this in an individual controller action to define which formats the action will respond with. This can be used to define provides behavior in individual actions or to override a global setting set with @provides in the controller's `init()`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">onlyProvides()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In your controller ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;cfset provides(&quot;html,xml,json&quot;)&gt;
&lt;/cffunction&gt;

&lt;!--- This action will provide the formats defined in `init()` above ---&gt;
&lt;cffunction name=&quot;list&quot;&gt;
	&lt;cfset products = model(&quot;product&quot;).findAll()&gt;
	&lt;cfset renderWith(products)&gt;
&lt;/cffunction&gt;

&lt;!--- This action will only provide the `html` type and will ignore what was defined in the call to `provides()` in the `init()` method above ---&gt;
&lt;cffunction name=&quot;new&quot;&gt;
	&lt;cfset onlyProvides(&quot;html&quot;)&gt;
	&lt;cfset model(&quot;product&quot;).new()&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="pagination" d:title="pagination" d:parental-control="1">
		<d:index d:value="pagination"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>pagination()</code></h1>
	
		<h2>Description</h2>
		<p>Returns a struct with information about the specificed paginated query. The keys that will be included in the struct are `currentPage`, `totalPages` and `totalRecords`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">pagination([ <em>handle</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>handle</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>query</code></td>
				<td valign="top">The handle given to the query to return pagination information for.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cfparam name=&quot;params.page&quot; default=&quot;1&quot;&gt;
&lt;cfset allAuthors = model(&quot;author&quot;).findAll(page=params.page, perPage=25, order=&quot;lastName&quot;, handle=&quot;authorsData&quot;)&gt;
&lt;cfset paginationData = pagination(&quot;authorsData&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="paginationlinks" d:title="paginationLinks" d:parental-control="1">
		<d:index d:value="paginationLinks"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>paginationLinks()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing links to pages based on a paginated query. Uses @linkTo internally to build the link, so you need to pass in a `route` name or a `controller`/`action`/`key` combination. All other @linkTo arguments can be supplied as well, in which case they are passed through directly to @linkTo. If you have paginated more than one query in the controller, you can use the `handle` argument to reference them. (Don't forget to pass in a `handle` to the @findAll function in your controller first.)</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">paginationLinks([ <em>windowSize</em>, <em>alwaysShowAnchors</em>, <em>anchorDivider</em>, <em>linkToCurrentPage</em>, <em>prepend</em>, <em>append</em>, <em>prependToPage</em>, <em>prependOnFirst</em>, <em>prependOnAnchor</em>, <em>appendToPage</em>, <em>appendOnLast</em>, <em>appendOnAnchor</em>, <em>classForCurrent</em>, <em>handle</em>, <em>name</em>, <em>showSinglePage</em>, <em>pageNumberAsParam</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>windowSize</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>2</code></td>
				<td valign="top">The number of page links to show around the current page.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>alwaysShowAnchors</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Whether or not links to the first and last page should always be displayed.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>anchorDivider</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code> ... </code></td>
				<td valign="top">String to place next to the anchors on either side of the list.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>linkToCurrentPage</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether or not the current page should be linked to.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String or HTML to be prepended before result.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String or HTML to be appended after result.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToPage</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String or HTML to be prepended before each page number.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prependOnFirst</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Whether or not to prepend the `prependToPage` string on the first page in the list.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependOnAnchor</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Whether or not to prepend the `prependToPage` string on the anchors.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToPage</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String or HTML to be appended after each page number.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>appendOnLast</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Whether or not to append the `appendToPage` string on the last page in the list.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendOnAnchor</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Whether or not to append the `appendToPage` string on the anchors.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>classForCurrent</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Class name for the current page number (if `linkToCurrentPage` is `true`, the class name will go on the `a` element. If not, a `span` element will be used).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>handle</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>query</code></td>
				<td valign="top">The handle given to the query that the pagination links should be displayed for.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>page</code></td>
				<td valign="top">The name of the param that holds the current page number.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>showSinglePage</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Will show a single page when set to `true`. (The default behavior is to return an empty string when there is only one page in the pagination).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>pageNumberAsParam</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Decides whether to link the page number as a param or as part of a route. (The default behavior is `true`).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Example 1: List authors page by page, 25 at a time ---&gt;
&lt;!--- Controller code ---&gt;
&lt;cfparam name=&quot;params.page&quot; default=&quot;1&quot;&gt;
&lt;cfset allAuthors = model(&quot;author&quot;).findAll(page=params.page, perPage=25, order=&quot;lastName&quot;)&gt;

&lt;!--- View code ---&gt;
&lt;ul&gt;
    &lt;cfoutput query=&quot;allAuthors&quot;&gt;
        &lt;li&gt;#firstName# #lastName#&lt;/li&gt;
    &lt;/cfoutput&gt;
&lt;/ul&gt;
&lt;cfoutput&gt;#paginationLinks(action=&quot;listAuthors&quot;)#&lt;/cfoutput&gt;

&lt;!--- Example 2: Using the same model call above, show all authors with a window size of 5 ---&gt;
&lt;!--- View code ---&gt;
&lt;cfoutput&gt;#paginationLinks(action=&quot;listAuthors&quot;, windowSize=5)#&lt;/cfoutput&gt;

&lt;!--- Example 3: If more than one paginated query is being run, then you need to reference the correct `handle` in the view ---&gt;
&lt;!--- Controller code ---&gt;
&lt;cfset allAuthors = model(&quot;author&quot;).findAll(handle=&quot;authQuery&quot;, page=5, order=&quot;id&quot;)&gt;

&lt;!--- View code ---&gt;
&lt;ul&gt;
    &lt;cfoutput&gt;#paginationLinks(action=&quot;listAuthors&quot;, handle=&quot;authQuery&quot;, prependToLink=&quot;&lt;li&gt;&quot;, appendToLink=&quot;&lt;/li&gt;&quot;)#&lt;/cfoutput&gt;
&lt;/ul&gt;

&lt;!--- Example 4: Call to `paginationLinks` using routes ---&gt;
&lt;!--- Route setup in config/routes.cfm ---&gt;
&lt;cfset addRoute(name=&quot;paginatedCommentListing&quot;, pattern=&quot;blog/[year]/[month]/[day]/[page]&quot;, controller=&quot;theBlog&quot;, action=&quot;stats&quot;)&gt;
&lt;cfset addRoute(name=&quot;commentListing&quot;, pattern=&quot;blog/[year]/[month]/[day]&quot;,  controller=&quot;theBlog&quot;, action=&quot;stats&quot;)&gt;

&lt;!--- Ccontroller code ---&gt;
&lt;cfparam name=&quot;params.page&quot; default=&quot;1&quot;&gt;
&lt;cfset comments = model(&quot;comment&quot;).findAll(page=params.page, order=&quot;createdAt&quot;)&gt;

&lt;!--- View code ---&gt;
&lt;ul&gt;
    &lt;cfoutput&gt;#paginationLinks(route=&quot;paginatedCommentListing&quot;, year=2009, month=&quot;feb&quot;, day=10)#&lt;/cfoutput&gt;
&lt;/ul&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="passwordfield" d:title="passwordField" d:parental-control="1">
		<d:index d:value="passwordField"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>passwordField()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a password field form control based on the supplied `objectName` and `property`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">passwordField(<em>objectName</em>, <em>property</em> [, <em>association</em>, <em>position</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em>, <em>errorElement</em>, <em>errorClass</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>objectName</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The variable name of the object to build the form control for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the property to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>association</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>position</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>useDefaultLabel</code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>errorElement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>span</code></td>
				<td valign="top">HTML tag to wrap the form control with when the object contains errors.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>errorClass</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>fieldWithErrors</code></td>
				<td valign="top">The class name of the HTML tag that wraps the form control when there are errors.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Provide a `label` and the required `objectName` and `property` ---&gt;
&lt;cfoutput&gt;
    #passwordField(label=&quot;Password&quot;, objectName=&quot;user&quot;, property=&quot;password&quot;)#
&lt;/cfoutput&gt;

&lt;!--- Display fields for passwords provided by the `passwords` association and nested properties ---&gt;
&lt;fieldset&gt;
	&lt;legend&gt;Passwords&lt;/legend&gt;
	&lt;cfloop from=&quot;1&quot; to=&quot;#ArrayLen(user.passwords)#&quot; index=&quot;i&quot;&gt;
		#passwordField(label=&quot;Password ##i#&quot;, objectName=&quot;user&quot;, association=&quot;passwords&quot;, position=i, property=&quot;password&quot;)#
	&lt;/cfloop&gt;
&lt;/fieldset&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="passwordfieldtag" d:title="passwordFieldTag" d:parental-control="1">
		<d:index d:value="passwordFieldTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>passwordFieldTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a password field form control based on the supplied `name`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">passwordFieldTag(<em>name</em> [, <em>value</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>value</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Value to populate in tag's `value` attribute.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Basic usage usually involves a `label`, `name`, and `value` ---&gt;
&lt;cfoutput&gt;
    #passwordFieldTag(label=&quot;Password&quot;, name=&quot;password&quot;, value=params.password)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="pluginnames" d:title="pluginNames" d:parental-control="1">
		<d:index d:value="pluginNames"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>pluginNames()</code></h1>
	
		<h2>Description</h2>
		<p>Returns a list of all installed plugins' names.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">pluginNames()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Check if the Scaffold plugin is installed ---&gt;
&lt;cfif ListFindNoCase(&quot;scaffold&quot;, pluginNames())&gt;
	&lt;!--- do something cool ---&gt;
&lt;/cfif&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="pluralize" d:title="pluralize" d:parental-control="1">
		<d:index d:value="pluralize"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>pluralize()</code></h1>
	
		<h2>Description</h2>
		<p>Returns the plural form of the passed in word. Can also pluralize a word based on a value passed to the `count` argument.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">pluralize(<em>word</em> [, <em>count</em>, <em>returnCount</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>word</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The word to pluralize.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>count</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>-1</code></td>
				<td valign="top">Pluralization will occur when this value is not `1`.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>returnCount</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Will return `count` prepended to the pluralization when `true` and `count` is not `-1`.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Pluralize a word, will result in &quot;people&quot; ---&gt;
#pluralize(&quot;person&quot;)#

&lt;!--- Pluralize based on the count passed in ---&gt;
Your search returned #pluralize(word=&quot;person&quot;, count=users.RecordCount)#</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="primarykey" d:title="primaryKey" d:parental-control="1">
		<d:index d:value="primaryKey"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>primaryKey()</code></h1>
	
		<h2>Description</h2>
		<p>Returns the name of the primary key for this model's table. This is determined through database introspection. If composite primary keys have been used, they will both be returned in a list. This function is also aliased as `primaryKeys()`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">primaryKey([ <em>position</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>position</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>0</code></td>
				<td valign="top">If you are accessing a composite primary key, pass the position of a single key to fetch.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get the name of the primary key of the table mapped to the `employee` model (which is the `employees` table by default) ---&gt;
&lt;cfset keyName = model(&quot;employee&quot;).primaryKey()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="primarykeys" d:title="primaryKeys" d:parental-control="1">
		<d:index d:value="primaryKeys"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>primaryKeys()</code></h1>
	
		<h2>Description</h2>
		<p>Alias for @primaryKey. Use this for better readability when you're accessing multiple primary keys.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">primaryKeys([ <em>position</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>position</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>0</code></td>
				<td valign="top">If you are accessing a composite primary key, pass the position of a single key to fetch.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get a list of the names of the primary keys in the table mapped to the `employee` model (which is the `employees` table by default) ---&gt;
&lt;cfset keyNames = model(&quot;employee&quot;).primaryKeys()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="properties" d:title="properties" d:parental-control="1">
		<d:index d:value="properties"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>properties()</code></h1>
	
		<h2>Description</h2>
		<p>Returns a structure of all the properties with their names as keys and the values of the property as values.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">properties()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get a structure of all the properties for an object ---&gt;
&lt;cfset user = model(&quot;user&quot;).findByKey(1)&gt;
&lt;cfset props = user.properties()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="property" d:title="property" d:parental-control="1">
		<d:index d:value="property"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>property()</code></h1>
	
		<h2>Description</h2>
		<p>Use this method to map an object property to either a table column with a different name than the property or to a SQL expression. You only need to use this method when you want to override the default object relational mapping that Wheels performs.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">property(<em>name</em> [, <em>column</em>, <em>sql</em>, <em>label</em>, <em>defaultValue</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name that you want to use for the column or SQL function result in the CFML code.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>column</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the column in the database table to map the property to.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>sql</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">A SQL expression to use to calculate the property value.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">A custom label for this property to be referenced in the interface and error messages.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>defaultValue</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">A default value for this property.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Tell Wheels that when we are referring to `firstName` in the CFML code, it should translate to the `STR_USERS_FNAME` column when interacting with the database instead of the default (which would be the `firstname` column) ---&gt;
&lt;cfset property(name=&quot;firstName&quot;, column=&quot;STR_USERS_FNAME&quot;)&gt;

&lt;!--- Tell Wheels that when we are referring to `fullName` in the CFML code, it should concatenate the `STR_USERS_FNAME` and `STR_USERS_LNAME` columns ---&gt;
&lt;cfset property(name=&quot;fullName&quot;, sql=&quot;STR_USERS_FNAME + ' ' + STR_USERS_LNAME&quot;)&gt;

&lt;!--- Tell Wheels that when displaying error messages or labels for form fields, we want to use `First name(s)` as the label for the `STR_USERS_FNAME` column ---&gt;
&lt;cfset property(name=&quot;firstName&quot;, label=&quot;First name(s)&quot;)&gt;

&lt;!--- Tell Wheels that when creating new objects, we want them to be auto-populated with a `firstName` property of value `Dave` ---&gt;
&lt;cfset property(name=&quot;firstName&quot;, defaultValue=&quot;Dave&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="propertyispresent" d:title="propertyIsPresent" d:parental-control="1">
		<d:index d:value="propertyIsPresent"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>propertyIsPresent()</code></h1>
	
		<h2>Description</h2>
		<p>Returns `true` if the specified property exists on the model and is not a blank string.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">propertyIsPresent(<em>property</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of property to inspect.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get an object, set a value and then see if the property exists ---&gt;
&lt;cfset employee = model(&quot;employee&quot;).new()&gt;
&lt;cfset employee.firstName = &quot;dude&quot;&gt;
&lt;cfreturn employee.propertyIsPresent(&quot;firstName&quot;)&gt;&lt;!--- Returns true ---&gt;

&lt;cfset employee.firstName = &quot;&quot;&gt;
&lt;cfreturn employee.propertyIsPresent(&quot;firstName&quot;)&gt;&lt;!--- Returns false ---&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="propertynames" d:title="propertyNames" d:parental-control="1">
		<d:index d:value="propertyNames"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>propertyNames()</code></h1>
	
		<h2>Description</h2>
		<p>Returns a list of property names ordered by their respective column's ordinal position in the database table. Also includes calculated property names that will be generated by the Wheels ORM.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">propertyNames()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get a list of the property names in use in the user model ---&gt;
  		&lt;cfset propNames = model(&quot;user&quot;).propertyNames()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="protectedproperties" d:title="protectedProperties" d:parental-control="1">
		<d:index d:value="protectedProperties"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>protectedProperties()</code></h1>
	
		<h2>Description</h2>
		<p>Use this method to specify which properties cannot be set through mass assignment.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">protectedProperties([ <em>properties</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Property name (or list of property names) that are not allowed to be altered through mass assignment.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In `models/User.cfc`, `firstName` and `lastName` cannot be changed through mass assignment operations like `updateAll()` ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;cfset protectedProperties(&quot;firstName,lastName&quot;)&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="provides" d:title="provides" d:parental-control="1">
		<d:index d:value="provides"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>provides()</code></h1>
	
		<h2>Description</h2>
		<p>Defines formats that the controller will respond with upon request. The format can be requested through a URL variable called `format`, by appending the format name to the end of a URL as an extension (when URL rewriting is enabled), or in the request header.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">provides([ <em>formats</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>formats</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Formats to instruct the controller to provide. Valid values are `html` (the default), `xml`, `json`, `csv`, `pdf`, and `xls`.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In your controller ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;cfset provides(&quot;html,xml,json&quot;)&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="radiobutton" d:title="radioButton" d:parental-control="1">
		<d:index d:value="radioButton"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>radioButton()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a radio button form control based on the supplied `objectName` and `property`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">radioButton(<em>objectName</em>, <em>property</em>, <em>tagValue</em> [, <em>association</em>, <em>position</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em>, <em>errorElement</em>, <em>errorClass</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>objectName</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The variable name of the object to build the form control for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the property to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>association</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>position</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>tagValue</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The value of the radio button when `selected`.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>useDefaultLabel</code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>errorElement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>span</code></td>
				<td valign="top">HTML tag to wrap the form control with when the object contains errors.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>errorClass</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>fieldWithErrors</code></td>
				<td valign="top">The class name of the HTML tag that wraps the form control when there are errors.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Basic example view code ---&gt;
&lt;cfoutput&gt;
	&lt;fieldset&gt;
		&lt;legend&gt;Gender&lt;/legend&gt;
	    #radioButton(objectName=&quot;user&quot;, property=&quot;gender&quot;, tagValue=&quot;m&quot;, label=&quot;Male&quot;)#&lt;br /&gt;
        #radioButton(objectName=&quot;user&quot;, property=&quot;gender&quot;, tagValue=&quot;f&quot;, label=&quot;Female&quot;)#
	&lt;/fieldset&gt;
&lt;/cfoutput&gt;

&lt;!--- Shows radio buttons for selecting the genders for all committee members provided by the `members` association and nested properties ---&gt;
&lt;cfoutput&gt;
	&lt;cfloop from=&quot;1&quot; to=&quot;#ArrayLen(committee.members)#&quot; index=&quot;i&quot;&gt;
		&lt;div&gt;
			&lt;h3&gt;#committee.members[i].fullName#:&lt;/h3&gt;
			&lt;div&gt;
				#radioButton(objectName=&quot;committee&quot;, association=&quot;members&quot;, position=i, property=&quot;gender&quot;, tagValue=&quot;m&quot;, label=&quot;Male&quot;)#&lt;br /&gt;
				#radioButton(objectName=&quot;committee&quot;, association=&quot;members&quot;, position=i, property=&quot;gender&quot;, tagValue=&quot;f&quot;, label=&quot;Female&quot;)#
			&lt;/div&gt;
		&lt;/div&gt;
	&lt;/cfloop&gt;
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="radiobuttontag" d:title="radioButtonTag" d:parental-control="1">
		<d:index d:value="radioButtonTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>radioButtonTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a radio button form control based on the supplied `name`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">radioButtonTag(<em>name</em>, <em>value</em> [, <em>checked</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>value</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Value to populate in tag's `value` attribute.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>checked</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether or not to check the radio button by default.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Basic usage usually involves a `label`, `name`, `value`, and `checked` value ---&gt;
&lt;cfoutput&gt;
    &lt;fieldset&gt;
		&lt;legend&gt;Gender&lt;/legend&gt;
	    #radioButtonTag(name=&quot;gender&quot;, value=&quot;m&quot;, label=&quot;Male&quot;, checked=true)#&lt;br /&gt;
        #radioButtonTag(name=&quot;gender&quot;, value=&quot;f&quot;, label=&quot;Female&quot;)#
	&lt;/fieldset&gt;
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="redirectto" d:title="redirectTo" d:parental-control="1">
		<d:index d:value="redirectTo"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>redirectTo()</code></h1>
	
		<h2>Description</h2>
		<p>Redirects the browser to the supplied `controller`/`action`/`key`, `route` or back to the referring page. Internally, this function uses the @URLFor function to build the link and the `cflocation` tag to perform the redirect.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">redirectTo([ <em>back</em>, <em>addToken</em>, <em>statusCode</em>, <em>route</em>, <em>controller</em>, <em>action</em>, <em>key</em>, <em>params</em>, <em>anchor</em>, <em>onlyPath</em>, <em>host</em>, <em>protocol</em>, <em>port</em>, <em>delay</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>back</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to redirect back to the referring page.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>addToken</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">See documentation for your CFML engine's implementation of `cflocation`.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>statusCode</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>302</code></td>
				<td valign="top">See documentation for your CFML engine's implementation of `cflocation`.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>route</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of a route that you have configured in `config/routes.cfm`.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>controller</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the controller to include in the URL.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>action</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the action to include in the URL.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>key</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Key(s) to include in the URL.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>params</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Any additional params to be set in the query string.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>anchor</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Sets an anchor name to be appended to the path.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>onlyPath</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">If `true`, returns only the relative URL (no protocol, host name or port).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>host</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set this to override the current host.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>protocol</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set this to override the current protocol.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>port</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>0</code></td>
				<td valign="top">Set this to override the current port number.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>delay</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to delay the redirection until after the rest of your action code has executed.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Redirect to an action after successfully saving a user ---&gt;
&lt;cfif user.save()&gt;
    &lt;cfset redirectTo(action=&quot;saveSuccessful&quot;)&gt;
&lt;/cfif&gt;

&lt;!--- Redirect to a specific page on a secure server ---&gt;
&lt;cfset redirectTo(controller=&quot;checkout&quot;, action=&quot;start&quot;, params=&quot;type=express&quot;, protocol=&quot;https&quot;)&gt;

&lt;!--- Redirect to a route specified in `config/routes.cfm` and pass in the screen name that the route takes ---&gt;
&lt;cfset redirectTo(route=&quot;profile&quot;, screenName=&quot;Joe&quot;)&gt;

&lt;!--- Redirect back to the page the user came from ---&gt;
&lt;cfset redirectTo(back=true)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="reload" d:title="reload" d:parental-control="1">
		<d:index d:value="reload"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>reload()</code></h1>
	
		<h2>Description</h2>
		<p>Reloads the property values of this object from the database.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">reload()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get an object, call a method on it that could potentially change values, and then reload the values from the database ---&gt;
&lt;cfset employee = model(&quot;employee&quot;).findByKey(params.key)&gt;
&lt;cfset employee.someCallThatChangesValuesInTheDatabase()&gt;
&lt;cfset employee.reload()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="rendernothing" d:title="renderNothing" d:parental-control="1">
		<d:index d:value="renderNothing"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>renderNothing()</code></h1>
	
		<h2>Description</h2>
		<p>Instructs the controller to render an empty string when it's finished processing the action. This is very similar to calling `cfabort` with the advantage that any after filters you have set on the action will still be run.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">renderNothing()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Render a blank white page to the client ---&gt;
&lt;cfset renderNothing()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="renderpage" d:title="renderPage" d:parental-control="1">
		<d:index d:value="renderPage"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>renderPage()</code></h1>
	
		<h2>Description</h2>
		<p>Instructs the controller which view template and layout to render when it's finished processing the action. Note that when passing values for `controller` and/or `action`, this function does not load the actual action but rather just loads the corresponding view template.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">renderPage([ <em>controller</em>, <em>action</em>, <em>template</em>, <em>layout</em>, <em>cache</em>, <em>returnAs</em>, <em>hideDebugInformation</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>controller</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Controller to include the view page for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>action</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Action to include the view page for.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>template</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">A specific template to render. Prefix with a leading slash `/` if you need to build a path from the root `views` folder.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>layout</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The layout to wrap the content in. Prefix with a leading slash `/` if you need to build a path from the root `views` folder. Pass `false` to not load a layout at all.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>cache</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Number of minutes to cache the content for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>returnAs</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set to `string` to return the result instead of automatically sending it to the client.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>hideDebugInformation</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to hide the debug information at the end of the output. This is useful when you're testing XML output in an environment where the global setting for `showDebugInformation` is `true`.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Render a view page for a different action within the same controller ---&gt;
&lt;cfset renderPage(action=&quot;edit&quot;)&gt;

&lt;!--- Render a view page for a different action within a different controller ---&gt;
&lt;cfset renderPage(controller=&quot;blog&quot;, action=&quot;new&quot;)&gt;

&lt;!--- Another way to render the blog/new template from within a different controller ---&gt;
&lt;cfset renderPage(template=&quot;/blog/new&quot;)&gt;

&lt;!--- Render the view page for the current action but without a layout and cache it for 60 minutes ---&gt;
&lt;cfset renderPage(layout=false, cache=60)&gt;

&lt;!--- Load a layout from a different folder within `views` ---&gt;
&lt;cfset renderPage(layout=&quot;/layouts/blog&quot;)&gt;

&lt;!--- Don't render the view immediately but rather return and store in a variable for further processing ---&gt;
&lt;cfset myView = renderPage(returnAs=&quot;string&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="renderpartial" d:title="renderPartial" d:parental-control="1">
		<d:index d:value="renderPartial"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>renderPartial()</code></h1>
	
		<h2>Description</h2>
		<p>Instructs the controller to render a partial when it's finished processing the action.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">renderPartial(<em>partial</em> [, <em>cache</em>, <em>layout</em>, <em>returnAs</em>, <em>dataFunction</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>partial</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the partial file to be used. Prefix with a leading slash `/` if you need to build a path from the root `views` folder. Do not include the partial filename's underscore and file extension.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>cache</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Number of minutes to cache the content for.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>layout</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The layout to wrap the content in. Prefix with a leading slash `/` if you need to build a path from the root `views` folder. Pass `false` to not load a layout at all.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>returnAs</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set to `string` to return the result instead of automatically sending it to the client.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>dataFunction</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Name of a controller function to load data from.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Render the partial `_comment.cfm` located in the current controller's view folder ---&gt;
&lt;cfset renderPartial(&quot;comment&quot;)&gt;

&lt;!--- Render the partial at `views/shared/_comment.cfm` ---&gt;
&lt;cfset renderPartial(&quot;/shared/comment&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="rendertext" d:title="renderText" d:parental-control="1">
		<d:index d:value="renderText"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>renderText()</code></h1>
	
		<h2>Description</h2>
		<p>Instructs the controller to render specified text when it's finished processing the action.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">renderText(<em>text</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>text</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The text to be rendered.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Render just the text &quot;Done!&quot; to the client ---&gt;
&lt;cfset renderText(&quot;Done!&quot;)&gt;

&lt;!--- Render serialized product data to the client ---&gt;
&lt;cfset products = model(&quot;product&quot;).findAll()&gt;
&lt;cfset renderText(SerializeJson(products))&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="renderwith" d:title="renderWith" d:parental-control="1">
		<d:index d:value="renderWith"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>renderWith()</code></h1>
	
		<h2>Description</h2>
		<p>Instructs the controller to render the data passed in to the format that is requested. If the format requested is `json` or `xml`, Wheels will transform the data into that format automatically. For other formats (or to override the automatic formatting), you can also create a view template in this format: `nameofaction.xml.cfm`, `nameofaction.json.cfm`, `nameofaction.pdf.cfm`, etc.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">renderWith(<em>data</em> [, <em>controller</em>, <em>action</em>, <em>template</em>, <em>layout</em>, <em>cache</em>, <em>returnAs</em>, <em>hideDebugInformation</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>data</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Data to format and render.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>controller</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Controller to include the view page for.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>action</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Action to include the view page for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>template</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">A specific template to render. Prefix with a leading slash `/` if you need to build a path from the root `views` folder.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>layout</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The layout to wrap the content in. Prefix with a leading slash `/` if you need to build a path from the root `views` folder. Pass `false` to not load a layout at all.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>cache</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Number of minutes to cache the content for.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>returnAs</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set to `string` to return the result instead of automatically sending it to the client.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>hideDebugInformation</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to hide the debug information at the end of the output. This is useful when you're testing XML output in an environment where the global setting for `showDebugInformation` is `true`.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In your controller ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;cfset provides(&quot;html,xml,json&quot;)&gt;
&lt;/cffunction&gt;

&lt;!--- This action will provide the formats defined in `init()` above ---&gt;
&lt;cffunction name=&quot;list&quot;&gt;
	&lt;cfset products = model(&quot;product&quot;).findAll()&gt;
	&lt;cfset renderWith(products)&gt;
&lt;/cffunction&gt;

&lt;!--- This action will only provide the `html` type and will ignore what was defined in the call to `provides()` in the `init()` method above ---&gt;
&lt;cffunction name=&quot;new&quot;&gt;
	&lt;cfset onlyProvides(&quot;html&quot;)&gt;
	&lt;cfset model(&quot;product&quot;).new()&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="resetcycle" d:title="resetCycle" d:parental-control="1">
		<d:index d:value="resetCycle"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>resetCycle()</code></h1>
	
		<h2>Description</h2>
		<p>Resets a cycle so that it starts from the first list value the next time it is called.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">resetCycle([ <em>name</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>default</code></td>
				<td valign="top">The name of the cycle to reset.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- alternating row colors and shrinking emphasis ---&gt;
&lt;cfoutput query=&quot;employees&quot; group=&quot;departmentId&quot;&gt;
	&lt;div class=&quot;#cycle(values=&quot;even,odd&quot;, name=&quot;row&quot;)#&quot;&gt;
		&lt;ul&gt;
			&lt;cfoutput&gt;
				&lt;cfset rank = cycle(values=&quot;president,vice-president,director,manager,specialist,intern&quot;, name=&quot;position&quot;)&gt;
				&lt;li class=&quot;#rank#&quot;&gt;#categories.categoryName#&lt;/li&gt;
				&lt;cfset resetCycle(&quot;emphasis&quot;)&gt;
			&lt;/cfoutput&gt;
		&lt;/ul&gt;
	&lt;/div&gt;
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="response" d:title="response" d:parental-control="1">
		<d:index d:value="response"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>response()</code></h1>
	
		<h2>Description</h2>
		<p>Returns content that Wheels will send to the client in response to the request.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">response()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In a controller ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;cfset filters(type=&quot;after&quot;, through=&quot;translateResponse&quot;)&gt;
&lt;/cffunction&gt;

&lt;!--- After filter translates response and sets it ---&gt;
&lt;cffunction name=&quot;translateResponse&quot;&gt;
	&lt;cfset var wheelsResponse = response()&gt;
	&lt;cfset var translatedResponse = someTranslationMethod(wheelsResponse)&gt;
	&lt;cfset setResponse(translatedResponse)&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="save" d:title="save" d:parental-control="1">
		<d:index d:value="save"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>save()</code></h1>
	
		<h2>Description</h2>
		<p>Saves the object if it passes validation and callbacks. Returns `true` if the object was saved successfully to the database, `false` if not.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">save([ <em>parameterize</em>, <em>reload</em>, <em>validate</em>, <em>transaction</em>, <em>callbacks</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>reload</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to reload the object from the database once an insert/update has completed.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>validate</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to skip validations for this operation.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>transaction</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>callbacks</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to disable callbacks for this operation.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Save the user object to the database (will automatically do an `INSERT` or `UPDATE` statement depending on if the record is new or already exists ---&gt;
&lt;cfset user.save()&gt;

&lt;!--- Save the user object directly in an if statement without using `cfqueryparam` and take appropriate action based on the result ---&gt;
&lt;cfif user.save(parameterize=false)&gt;
	&lt;cfset flashInsert(notice=&quot;The user was saved!&quot;)&gt;
	&lt;cfset redirectTo(action=&quot;edit&quot;)&gt;
&lt;cfelse&gt;
	&lt;cfset flashInsert(alert=&quot;Error, please correct!&quot;)&gt;
	&lt;cfset renderPage(action=&quot;edit&quot;)&gt;
&lt;/cfif&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="secondselecttag" d:title="secondSelectTag" d:parental-control="1">
		<d:index d:value="secondSelectTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>secondSelectTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing one select form control for the seconds of a minute based on the supplied `name`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">secondSelectTag(<em>name</em> [, <em>selected</em>, <em>includeBlank</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>selected</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The second that should be selected initially.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>includeBlank</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, &quot;- Select One -&quot;).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- This &quot;Tag&quot; version of the function accepts a `name` and `selected` instead of binding to a model object ---&gt;
&lt;cfoutput&gt;
    #secondSelectTag(name=&quot;secondsToLaunch&quot;, selected=params.secondsToLaunch)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="select" d:title="select" d:parental-control="1">
		<d:index d:value="select"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>select()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a `select` form control based on the supplied `objectName` and `property`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">select(<em>objectName</em>, <em>property</em>, <em>options</em> [, <em>association</em>, <em>position</em>, <em>includeBlank</em>, <em>valueField</em>, <em>textField</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em>, <em>errorElement</em>, <em>errorClass</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>objectName</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The variable name of the object to build the form control for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the property to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>association</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>position</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>options</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">A collection to populate the select form control with. Can be a query recordset or an array of objects.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeBlank</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, &quot;- Select One -&quot;).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>valueField</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The column or property to use for the value of each list element. Used only when a query or array of objects has been supplied in the `options` argument.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>textField</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The column or property to use for the value of each list element that the end user will see. Used only when a query or array of objects has been supplied in the `options` argument.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>useDefaultLabel</code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>errorElement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>span</code></td>
				<td valign="top">HTML tag to wrap the form control with when the object contains errors.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>errorClass</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>fieldWithErrors</code></td>
				<td valign="top">The class name of the HTML tag that wraps the form control when there are errors.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Example 1: Basic `select` field with `label` and required `objectName` and `property` arguments ---&gt;
&lt;!--- - Controller code ---&gt;
&lt;cfset authors = model(&quot;author&quot;).findAll()&gt;

&lt;!--- - View code ---&gt;
&lt;cfoutput&gt;
    &lt;p&gt;#select(objectName=&quot;book&quot;, property=&quot;authorId&quot;, options=authors)#&lt;/p&gt;
&lt;/cfoutput&gt;

&lt;!--- Example 2: Shows `select` fields for selecting order statuses for all shipments provided by the `orders` association and nested properties ---&gt;
&lt;!--- - Controller code ---&gt;
&lt;cfset shipment = model(&quot;shipment&quot;).findByKey(key=params.key, where=&quot;shipments.statusId=#application.NEW_STATUS_ID#&quot;, include=&quot;order&quot;)&gt;
&lt;cfset statuses = model(&quot;status&quot;).findAll(order=&quot;name&quot;)&gt;

&lt;!--- - View code ---&gt;
&lt;cfoutput&gt;
	&lt;cfloop from=&quot;1&quot; to=&quot;#ArrayLen(shipments.orders)#&quot; index=&quot;i&quot;&gt;
		#select(label=&quot;Order ##shipments.orders[i].orderNum#&quot;, objectName=&quot;shipment&quot;, association=&quot;orders&quot;, position=i, property=&quot;statusId&quot;, options=statuses)#
	&lt;/cfloop&gt;
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="selecttag" d:title="selectTag" d:parental-control="1">
		<d:index d:value="selectTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>selectTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a select form control based on the supplied `name` and `options`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">selectTag(<em>name</em>, <em>options</em> [, <em>selected</em>, <em>includeBlank</em>, <em>multiple</em>, <em>valueField</em>, <em>textField</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>options</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">A collection to populate the select form control with. Can be a query recordset or an array of objects.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>selected</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Value of option that should be selected by default.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeBlank</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, &quot;- Select One -&quot;).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>multiple</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether to allow multiple selection of options in the select form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>valueField</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The column or property to use for the value of each list element. Used only when a query or array of objects has been supplied in the `options` argument.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>textField</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The column or property to use for the value of each list element that the end user will see. Used only when a query or array of objects has been supplied in the `options` argument.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Controller code ---&gt;
&lt;cfset cities = model(&quot;city&quot;).findAll()&gt;

&lt;!--- View code ---&gt;
&lt;cfoutput&gt;
    #selectTag(name=&quot;cityId&quot;, options=cities)#
&lt;/cfoutput&gt;

&lt;!--- Do this when Wheels isn't grabbing the correct values for the `option`s' values and display texts ---&gt;
&lt;cfoutput&gt;
	#selectTag(name=&quot;cityId&quot;, options=cities, valueField=&quot;id&quot;, textField=&quot;name&quot;)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="sendemail" d:title="sendEmail" d:parental-control="1">
		<d:index d:value="sendEmail"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>sendEmail()</code></h1>
	
		<h2>Description</h2>
		<p>Sends an email using a template and an optional layout to wrap it in. Besides the Wheels-specific arguments documented here, you can also pass in any argument that is accepted by the `cfmail` tag as well as your own arguments to be used by the view.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">sendEmail(<em>from</em>, <em>to</em>, <em>subject</em> [, <em>template</em>, <em>layout</em>, <em>file</em>, <em>detectMultipart</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>template</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The path to the email template or two paths if you want to send a multipart email. if the `detectMultipart` argument is `false`, the template for the text version should be the first one in the list. This argument is also aliased as `templates`.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>from</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Email address to send from.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>to</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">List of email addresses to send the email to.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>subject</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The subject line of the email.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>layout</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Layout(s) to wrap the email template in. This argument is also aliased as `layouts`.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>file</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">A list of the names of the files to attach to the email. This will reference files stored in the `files` folder (or a path relative to it). This argument is also aliased as `files`.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>detectMultipart</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">When set to `true` and multiple values are provided for the `template` argument, Wheels will detect which of the templates is text and which one is HTML (by counting the `&lt;` characters).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get a member and send a welcome email, passing in a few custom variables to the template ---&gt;
&lt;cfset newMember = model(&quot;member&quot;).findByKey(params.member.id)&gt;
&lt;cfset sendEmail(
	to=newMember.email,
	template=&quot;myemailtemplate&quot;,
	subject=&quot;Thank You for Becoming a Member&quot;,
	recipientName=newMember.name,
	startDate=newMember.startDate
)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="sendfile" d:title="sendFile" d:parental-control="1">
		<d:index d:value="sendFile"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>sendFile()</code></h1>
	
		<h2>Description</h2>
		<p>Sends a file to the user (from the `files` folder or a path relative to it by default).</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">sendFile(<em>file</em> [, <em>name</em>, <em>type</em>, <em>disposition</em>, <em>directory</em>, <em>deleteFile</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>file</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The file to send to the user.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The file name to show in the browser download dialog box.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>type</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The HTTP content type to deliver the file as.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>disposition</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>attachment</code></td>
				<td valign="top">Set to `inline` to have the browser handle the opening of the file (possibly inline in the browser) or set to `attachment` to force a download dialog box.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>directory</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Directory outside of the webroot where the file exists. Must be a full path.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>deleteFile</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Pass in `true` to delete the file on the server after sending it.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Send a PDF file to the user ---&gt;
&lt;cfset sendFile(file=&quot;wheels_tutorial_20081028_J657D6HX.pdf&quot;)&gt;

&lt;!--- Send the same file but give the user a different name in the browser dialog window ---&gt;
&lt;cfset sendFile(file=&quot;wheels_tutorial_20081028_J657D6HX.pdf&quot;, name=&quot;Tutorial.pdf&quot;)&gt;

&lt;!--- Send a file that is located outside of the web root ---&gt;
&lt;cfset sendFile(file=&quot;../../tutorials/wheels_tutorial_20081028_J657D6HX.pdf&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="set" d:title="set" d:parental-control="1">
		<d:index d:value="set"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>set()</code></h1>
	
		<h2>Description</h2>
		<p>Use to configure a global setting or set a default for a function.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">set()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Example 1: Set the `URLRewriting` setting to `Partial` ---&gt;
&lt;cfset set(URLRewriting=&quot;Partial&quot;)&gt;

&lt;!--- Example 2: Set default values for the arguments in the `buttonTo` view helper. This works for the majority of Wheels functions/arguments. ---&gt;
&lt;cfset set(functionName=&quot;buttonTo&quot;, onlyPath=true, host=&quot;&quot;, protocol=&quot;&quot;, port=0, text=&quot;&quot;, confirm=&quot;&quot;, image=&quot;&quot;, disable=&quot;&quot;)&gt;

&lt;!--- Example 3: Set the default values for a form helper to get the form marked up to your preferences ---&gt;
&lt;cfset set(functionName=&quot;textField&quot;, labelPlacement=&quot;before&quot;, prependToLabel=&quot;&lt;div&gt;&quot;, append=&quot;&lt;/div&gt;&quot;, appendToLabel=&quot;&lt;br /&gt;&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="setfilterchain" d:title="setFilterChain" d:parental-control="1">
		<d:index d:value="setFilterChain"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>setFilterChain()</code></h1>
	
		<h2>Description</h2>
		<p>Use this function if you need a more low level way of setting the entire filter chain for a controller.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">setFilterChain(<em>chain</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>chain</code></td>
				<td valign="top"><code>array</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">An array of structs, each of which represent an `argumentCollection` that get passed to the `filters` function. This should represent the entire filter chain that you want to use for this controller.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Set filter chain directly in an array ---&gt;
&lt;cfset setFilterChain([
	{through=&quot;restrictAccess&quot;},
	{through=&quot;isLoggedIn,checkIPAddress&quot;, except=&quot;home,login&quot;},
	{type=&quot;after&quot;, through=&quot;logConversion&quot;, only=&quot;thankYou&quot;}
])&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="setpagination" d:title="setPagination" d:parental-control="1">
		<d:index d:value="setPagination"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>setPagination()</code></h1>
	
		<h2>Description</h2>
		<p>Allows you to set a pagination handle for a custom query so you can perform pagination on it in your view with `paginationLinks()`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">setPagination(<em>totalRecords</em> [, <em>currentPage</em>, <em>perPage</em>, <em>handle</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>totalRecords</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Total count of records that should be represented by the paginated links.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>currentPage</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>1</code></td>
				<td valign="top">Page number that should be represented by the data being fetched and the paginated links.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>perPage</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>25</code></td>
				<td valign="top">Number of records that should be represented on each page of data.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>handle</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>query</code></td>
				<td valign="top">Name of handle to reference in @paginationLinks.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!---
	Note that there are two ways to do pagination yourself using
	a custom query.
	
	1) Do a query that grabs everything that matches and then use
	the `cfouput` or `cfloop` tag to page through the results.
		
	2) Use your database to make 2 queries. The first query
	basically does a count of the total number of records that match
	the criteria and the second query actually selects the page of
	records for retrieval.
	
	In the example below, we will show how to write a custom query
	using both of these methods. Note that the syntax where your
	database performs the pagination will differ depending on the
	database engine you are using. Plese consult your database
	engine's documentation for the correct syntax.
		
	Also note that the view code will differ depending on the method
	used.
---&gt;

&lt;!--- 
	First method: Handle the pagination through your CFML engine
---&gt;

&lt;!--- Model code ---&gt;
&lt;!--- In your model (ie. User.cfc), create a custom method for your custom query ---&gt;
&lt;cffunction name=&quot;myCustomQuery&quot;&gt;
	&lt;cfargument name=&quot;page&quot; type=&quot;numeric&quot;&gt;
	&lt;cfargument name=&quot;perPage&quot; type=&quot;numeric&quot; required=&quot;false&quot; default=&quot;25&quot;&gt;
				
	&lt;cfquery name=&quot;local.customQuery&quot; datasource=&quot;#get('dataSourceName')#&quot;&gt;
		SELECT * FROM users
	&lt;/cfquery&gt;

	&lt;cfset setPagination(totalRecords=local.customQuery.RecordCount, currentPage=arguments.page, perPage=arguments.perPage, handle=&quot;myCustomQueryHandle&quot;)&gt;
	&lt;cfreturn customQuery&gt;
&lt;/cffunction&gt;
		
&lt;!--- Controller code ---&gt;
&lt;cffunction name=&quot;list&quot;&gt;
	&lt;cfparam name=&quot;params.page&quot; default=&quot;1&quot;&gt;
	&lt;cfparam name=&quot;params.perPage&quot; default=&quot;25&quot;&gt;
	
	&lt;cfset allUsers = model(&quot;user&quot;).myCustomQuery(page=params.page, perPage=params.perPage)&gt;
	&lt;!--- 
		Because we're going to let `cfoutput`/`cfloop` handle the pagination,
		we're going to need to get some addition information about the
		pagination.
	 ---&gt;
	&lt;cfset paginationData = pagination(&quot;myCustomQueryHandle&quot;)&gt;
&lt;/cffunction&gt;

&lt;!--- View code (using `cfloop`) ---&gt;
&lt;!--- Use the information from `paginationData` to page through the records ---&gt;
&lt;cfoutput&gt;
&lt;ul&gt;
    &lt;cfloop query=&quot;allUsers&quot; statrow=&quot;#paginationData.startrow#&quot; endrow=&quot;#paginationData.endrow#&quot;&gt;
        &lt;li&gt;#allUsers.firstName# #allUsers.lastName#&lt;/li&gt;
    &lt;/cfloop&gt;
&lt;/ul&gt;
#paginationLinks(handle=&quot;myCustomQueryHandle&quot;)#
&lt;/cfoutput&gt;

&lt;!--- View code (using `cfoutput`) ---&gt;
&lt;!--- Use the information from `paginationData` to page through the records ---&gt;
&lt;ul&gt;
    &lt;cfoutput query=&quot;allUsers&quot; statrow=&quot;#paginationData.startrow#&quot; maxrows=&quot;#paginationData.maxrows#&quot;&gt;
        &lt;li&gt;#allUsers.firstName# #allUsers.lastName#&lt;/li&gt;
    &lt;/cfoutput&gt;
&lt;/ul&gt;
&lt;cfoutput&gt;#paginationLinks(handle=&quot;myCustomQueryHandle&quot;)#&lt;/cfoutput&gt;


&lt;!--- 
	Second method: Handle the pagination through the database
---&gt;

&lt;!--- Model code ---&gt;
&lt;!--- In your model (ie. `User.cfc`), create a custom method for your custom query ---&gt;
&lt;cffunction name=&quot;myCustomQuery&quot;&gt;
	&lt;cfargument name=&quot;page&quot; type=&quot;numeric&quot;&gt;
	&lt;cfargument name=&quot;perPage&quot; type=&quot;numeric&quot; required=&quot;false&quot; default=&quot;25&quot;&gt;
	
	&lt;cfquery name=&quot;local.customQueryCount&quot; datasource=&quot;#get('dataSouceName')#&quot;&gt;
		SELECT COUNT(*) AS theCount FROM users
	&lt;/cfquery&gt;
				
	&lt;cfquery name=&quot;local.customQuery&quot; datasource=&quot;#get('dataSourceName')#&quot;&gt;
		SELECT * FROM users
		LIMIT #arguments.page# OFFSET #arguments.perPage#
	&lt;/cfquery&gt;
	
	&lt;!--- Notice the we use the value from the first query for `totalRecords`  ---&gt;
	&lt;cfset setPagination(totalRecords=local.customQueryCount.theCount, currentPage=arguments.page, perPage=arguments.perPage, handle=&quot;myCustomQueryHandle&quot;)&gt;
	&lt;!--- We return the second query ---&gt;
	&lt;cfreturn customQuery&gt;
&lt;/cffunction&gt;
		
&lt;!--- Controller code ---&gt;
&lt;cffunction name=&quot;list&quot;&gt;
	&lt;cfparam name=&quot;params.page&quot; default=&quot;1&quot;&gt;
	&lt;cfparam name=&quot;params.perPage&quot; default=&quot;25&quot;&gt;
	&lt;cfset allUsers = model(&quot;user&quot;).myCustomQuery(page=params.page, perPage=params.perPage)&gt;
&lt;/cffunction&gt;

&lt;!--- View code (using `cfloop`) ---&gt;
&lt;cfoutput&gt;
&lt;ul&gt;
    &lt;cfloop query=&quot;allUsers&quot;&gt;
        &lt;li&gt;#allUsers.firstName# #allUsers.lastName#&lt;/li&gt;
    &lt;/cfloop&gt;
&lt;/ul&gt;
#paginationLinks(handle=&quot;myCustomQueryHandle&quot;)#
&lt;/cfoutput&gt;

&lt;!--- View code (using `cfoutput`) ---&gt;
&lt;ul&gt;
    &lt;cfoutput query=&quot;allUsers&quot;&gt;
        &lt;li&gt;#allUsers.firstName# #allUsers.lastName#&lt;/li&gt;
    &lt;/cfoutput&gt;
&lt;/ul&gt;
&lt;cfoutput&gt;#paginationLinks(handle=&quot;myCustomQueryHandle&quot;)#&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="setprimarykey" d:title="setPrimaryKey" d:parental-control="1">
		<d:index d:value="setPrimaryKey"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>setPrimaryKey()</code></h1>
	
		<h2>Description</h2>
		<p>Allows you to pass in the name(s) of the property(s) that should be used as the primary key(s). Pass as a list if defining a composite primary key. Also aliased as `setPrimaryKeys()`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">setPrimaryKey(<em>property</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Property (or list of properties) to set as the primary key.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In `models/User.cfc`, define the primary key as a column called `userID` ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;cfset setPrimaryKey(&quot;userID&quot;)&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="setprimarykeys" d:title="setPrimaryKeys" d:parental-control="1">
		<d:index d:value="setPrimaryKeys"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>setPrimaryKeys()</code></h1>
	
		<h2>Description</h2>
		<p>Alias for @setPrimaryKey. Use this for better readability when you're setting multiple properties as the primary key.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">setPrimaryKeys(<em>property</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Property (or list of properties) to set as the primary key.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In `models/Subscription.cfc`, define the primary key as composite of the columns `customerId` and `publicationId` ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;cfset setPrimaryKeys(&quot;customerId,publicationId&quot;)&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="setproperties" d:title="setProperties" d:parental-control="1">
		<d:index d:value="setProperties"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>setProperties()</code></h1>
	
		<h2>Description</h2>
		<p>Allows you to set all the properties of an object at once by passing in a structure with keys matching the property names.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">setProperties([ <em>properties</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>struct</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">The properties you want to set on the object (can also be passed in as named arguments).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Update the properties of the object with the params struct containing the values of a form post ---&gt;
&lt;cfset user = model(&quot;user&quot;).findByKey(1)&gt;
&lt;cfset user.setProperties(params.user)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="setresponse" d:title="setResponse" d:parental-control="1">
		<d:index d:value="setResponse"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>setResponse()</code></h1>
	
		<h2>Description</h2>
		<p>Sets content that Wheels will send to the client in response to the request.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">setResponse(<em>content</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>content</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The content to set as the response.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In a controller ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;cfset filters(type=&quot;after&quot;, through=&quot;translateResponse&quot;)&gt;
&lt;/cffunction&gt;

&lt;!--- After filter translates response and sets it ---&gt;
&lt;cffunction name=&quot;translateResponse&quot;&gt;
	&lt;cfset var wheelsResponse = response()&gt;
	&lt;cfset var translatedResponse = someTranslationFunction(wheelsResponse)&gt;
	&lt;cfset setResponse(translatedResponse)&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="settablenameprefix" d:title="setTableNamePrefix" d:parental-control="1">
		<d:index d:value="setTableNamePrefix"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>setTableNamePrefix()</code></h1>
	
		<h2>Description</h2>
		<p>Sets a prefix to prepend to the table name when this model runs SQL queries.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">setTableNamePrefix(<em>prefix</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>prefix</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">A prefix to prepend to the table name.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In `models/User.cfc`, add a prefix to the default table name of `tbl` ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;cfset setTableNamePrefix(&quot;tbl&quot;)&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="setverificationchain" d:title="setVerificationChain" d:parental-control="1">
		<d:index d:value="setVerificationChain"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>setVerificationChain()</code></h1>
	
		<h2>Description</h2>
		<p>Use this function if you need a more low level way of setting the entire verification chain for a controller.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">setVerificationChain(<em>chain</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>chain</code></td>
				<td valign="top"><code>array</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">An array of structs, each of which represent an `argumentCollection` that get passed to the `verifies` function. This should represent the entire verification chain that you want to use for this controller.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Set verification chain directly in an array ---&gt;
&lt;cfset setVerificationChain([
	{only=&quot;handleForm&quot;, post=true},
	{only=&quot;edit&quot;, get=true, params=&quot;userId&quot;, paramsTypes=&quot;integer&quot;},
	{only=&quot;edit&quot;, get=true, params=&quot;userId&quot;, paramsTypes=&quot;integer&quot;, handler=&quot;index&quot;, error=&quot;Invalid userId&quot;}
])&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="simpleformat" d:title="simpleFormat" d:parental-control="1">
		<d:index d:value="simpleFormat"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>simpleFormat()</code></h1>
	
		<h2>Description</h2>
		<p>Replaces single newline characters with HTML break tags and double newline characters with HTML paragraph tags (properly closed to comply with XHTML standards).</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">simpleFormat(<em>text</em> [, <em>wrap</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>text</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The text to format.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>wrap</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to wrap the result in a paragraph.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- How most of your calls will look ---&gt;
#simpleFormat(post.comments)#

&lt;!--- Demonstrates what output looks like with specific data ---&gt;
&lt;cfsavecontent variable=&quot;comment&quot;&gt;
	I love this post!

	Here's why:
	* Short
	* Succinct
	* Awesome
&lt;/cfsavecontent&gt;
#simpleFormat(comment)#
-&gt; &lt;p&gt;I love this post!&lt;/p&gt;
   &lt;p&gt;
       Here's why:&lt;br /&gt;
	   * Short&lt;br /&gt;
	   * Succinct&lt;br /&gt;
	   * Awesome
   &lt;/p&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="singularize" d:title="singularize" d:parental-control="1">
		<d:index d:value="singularize"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>singularize()</code></h1>
	
		<h2>Description</h2>
		<p>Returns the singular form of the passed in word.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">singularize(<em>word</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>word</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to singularize.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Singularize a word, will result in &quot;language&quot; ---&gt;
#singularize(&quot;languages&quot;)#</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="startformtag" d:title="startFormTag" d:parental-control="1">
		<d:index d:value="startFormTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>startFormTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing the opening form tag. The form's action will be built according to the same rules as `URLFor`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">startFormTag([ <em>method</em>, <em>multipart</em>, <em>spamProtection</em>, <em>route</em>, <em>controller</em>, <em>action</em>, <em>key</em>, <em>params</em>, <em>anchor</em>, <em>onlyPath</em>, <em>host</em>, <em>protocol</em>, <em>port</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>method</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>post</code></td>
				<td valign="top">The type of method to use in the form tag. `get` and `post` are the options.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>multipart</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` if the form should be able to upload files.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>spamProtection</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to protect the form against spammers (done with JavaScript).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>route</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of a route that you have configured in `config/routes.cfm`.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>controller</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the controller to include in the URL.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>action</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the action to include in the URL.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>key</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Key(s) to include in the URL.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>params</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Any additional params to be set in the query string.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>anchor</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Sets an anchor name to be appended to the path.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>onlyPath</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">If `true`, returns only the relative URL (no protocol, host name or port).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>host</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set this to override the current host.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>protocol</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set this to override the current protocol.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>port</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>0</code></td>
				<td valign="top">Set this to override the current port number.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- view code ---&gt;
&lt;cfoutput&gt;
    #startFormTag(action=&quot;create&quot;, spamProtection=true)#
        &lt;!--- your form controls ---&gt;
    #endFormTag()#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="striplinks" d:title="stripLinks" d:parental-control="1">
		<d:index d:value="stripLinks"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>stripLinks()</code></h1>
	
		<h2>Description</h2>
		<p>Removes all links from an HTML string, leaving just the link text.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">stripLinks(<em>html</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>html</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The HTML to remove links from.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>#stripLinks(&quot;&lt;strong&gt;Wheels&lt;/strong&gt; is a framework for &lt;a href=&quot;http://www.adobe.com/products/coldfusion/&quot;&gt;ColdFusion&lt;/a&gt;.&quot;)#
-&gt; &lt;strong&gt;Wheels&lt;/strong&gt; is a framework for ColdFusion.</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="striptags" d:title="stripTags" d:parental-control="1">
		<d:index d:value="stripTags"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>stripTags()</code></h1>
	
		<h2>Description</h2>
		<p>Removes all HTML tags from a string.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">stripTags(<em>html</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>html</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The HTML to remove tag markup from.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>#stripTags(&quot;&lt;strong&gt;Wheels&lt;/strong&gt; is a framework for &lt;a href=&quot;http://www.adobe.com/products/coldfusion/&quot;&gt;ColdFusion&lt;/a&gt;.&quot;)#
-&gt; Wheels is a framework for ColdFusion.</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="stylesheetlinktag" d:title="styleSheetLinkTag" d:parental-control="1">
		<d:index d:value="styleSheetLinkTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>styleSheetLinkTag()</code></h1>
	
		<h2>Description</h2>
		<p>Returns a `link` tag for a stylesheet (or several) based on the supplied arguments.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">styleSheetLinkTag([ <em>sources</em>, <em>type</em>, <em>media</em>, <em>head</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>sources</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of one or many CSS files in the `stylesheets` folder, minus the `.css` extension. (Can also be called with the `source` argument.)</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>type</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>text/css</code></td>
				<td valign="top">The `type` attribute for the `link` tag.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>media</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>all</code></td>
				<td valign="top">The `media` attribute for the `link` tag.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>head</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to place the output in the `head` area of the HTML page instead of the default behavior, which is to place the output where the function is called from.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- view code ---&gt;
&lt;head&gt;
	&lt;!--- Includes `stylesheets/styles.css` ---&gt;
    #styleSheetLinkTag(&quot;styles&quot;)#
	&lt;!--- Includes `stylesheets/blog.css` and `stylesheets/comments.css` ---&gt;
	#styleSheetLinkTag(&quot;blog,comments&quot;)#
	&lt;!--- Includes printer style sheet ---&gt;
	#styleSheetLinkTag(source=&quot;print&quot;, media=&quot;print&quot;)#
&lt;/head&gt;

&lt;body&gt;
	&lt;!--- This will still appear in the `head` ---&gt;
	#styleSheetLinkTag(source=&quot;tabs&quot;, head=true)#
&lt;/body&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="submittag" d:title="submitTag" d:parental-control="1">
		<d:index d:value="submitTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>submitTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a submit button `form` control. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">submitTag([ <em>value</em>, <em>image</em>, <em>disable</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>value</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>Save changes</code></td>
				<td valign="top">Message to display in the button form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>image</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">File name of the image file to use in the button form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>disable</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Whether or not to disable the button upon clicking. (prevents double-clicking.)</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>!--- view code ---&gt;
&lt;cfoutput&gt;
    #startFormTag(action=&quot;something&quot;)#
        &lt;!--- form controls go here ---&gt;
        #submitTag()#
    #endFormTag()#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="sum" d:title="sum" d:parental-control="1">
		<d:index d:value="sum"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>sum()</code></h1>
	
		<h2>Description</h2>
		<p>Calculates the sum of values for a given property. Uses the SQL function `SUM`. If no records can be found to perform the calculation on you can use the `ifNull` argument to decide what should be returned.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">sum(<em>property</em> [, <em>where</em>, <em>include</em>, <em>distinct</em>, <em>parameterize</em>, <em>ifNull</em>, <em>includeSoftDeletes</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the property to get the sum for (must be a property of a numeric data type).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>where</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `&lt;&gt;`, `&lt;`, `&lt;=`, `&gt;`, `&gt;=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>include</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>distinct</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">When `true`, `SUM` returns the sum of unique values only.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>ifNull</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The value returned if no records are found. Common usage is to set this to `0` to make sure a numeric value is always returned instead of a blank string.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>includeSoftDeletes</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">You can set this argument to `true` to include soft-deleted records in the results.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get the sum of all salaries ---&gt;
&lt;cfset allSalaries = model(&quot;employee&quot;).sum(&quot;salary&quot;)&gt;

&lt;!--- Get the sum of all salaries for employees in a given country ---&gt;
&lt;cfset allAustralianSalaries = model(&quot;employee&quot;).sum(property=&quot;salary&quot;, include=&quot;country&quot;, where=&quot;countryname='Australia'&quot;)&gt;

&lt;!--- Make sure a numeric value is always returned, even if there are no records analyzed by the query ---&gt;
&lt;cfset salarySum = model(&quot;employee&quot;).sum(property=&quot;salary&quot;, where=&quot;salary BETWEEN #params.min# AND #params.max#&quot;, ifNull=0)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="table" d:title="table" d:parental-control="1">
		<d:index d:value="table"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>table()</code></h1>
	
		<h2>Description</h2>
		<p>Use this method to tell Wheels what database table to connect to for this model. You only need to use this method when your table naming does not follow the standard Wheels convention of a singular object name mapping to a plural table name.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">table(<em>name</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the table to map this model to.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- In models/User.cfc ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;!--- Tell Wheels to use the `tbl_USERS` table in the database for the `user` model instead of the default (which would be `users`) ---&gt;
	&lt;cfset table(&quot;tbl_USERS&quot;)&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="tablename" d:title="tableName" d:parental-control="1">
		<d:index d:value="tableName"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>tableName()</code></h1>
	
		<h2>Description</h2>
		<p>Returns the name of the database table that this model is mapped to.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">tableName()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Check what table the user model uses ---&gt;
&lt;cfset whatAmIMappedTo = model(&quot;user&quot;).tableName()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="textarea" d:title="textArea" d:parental-control="1">
		<d:index d:value="textArea"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>textArea()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a text area field form control based on the supplied `objectName` and `property`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">textArea(<em>objectName</em>, <em>property</em> [, <em>association</em>, <em>position</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em>, <em>errorElement</em>, <em>errorClass</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>objectName</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The variable name of the object to build the form control for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the property to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>association</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>position</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>useDefaultLabel</code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>errorElement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>span</code></td>
				<td valign="top">HTML tag to wrap the form control with when the object contains errors.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>errorClass</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>fieldWithErrors</code></td>
				<td valign="top">The class name of the HTML tag that wraps the form control when there are errors.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Provide `label` and required `objectName` and `property` ---&gt;
&lt;cfoutput&gt;
    #textArea(label=&quot;Overview&quot;, objectName=&quot;article&quot;, property=&quot;overview&quot;)#
&lt;/cfoutput&gt;

&lt;!--- Display fields for photos provided by the `screenshots` association and nested properties ---&gt;
&lt;fieldset&gt;
	&lt;legend&gt;Screenshots&lt;/legend&gt;
	&lt;cfloop from=&quot;1&quot; to=&quot;#ArrayLen(site.screenshots)#&quot; index=&quot;i&quot;&gt;
		#fileField(label=&quot;File ##i#&quot;, objectName=&quot;site&quot;, association=&quot;screenshots&quot;, position=i, property=&quot;file&quot;)#
		#textArea(label=&quot;Caption ##i#&quot;, objectName=&quot;site&quot;, association=&quot;screenshots&quot;, position=i, property=&quot;caption&quot;)#
	&lt;/cfloop&gt;
&lt;/fieldset&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="textareatag" d:title="textAreaTag" d:parental-control="1">
		<d:index d:value="textAreaTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>textAreaTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a text area form control based on the supplied `name`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">textAreaTag(<em>name</em> [, <em>content</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>content</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Content to display in `textarea` on page load.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Basic usage usually involves a `label`, `name`, and `password` ---&gt;
&lt;cfoutput&gt;
    #textAreaTag(label=&quot;Description&quot;, name=&quot;description&quot;, value=params.description)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="textfield" d:title="textField" d:parental-control="1">
		<d:index d:value="textField"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>textField()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a text field form control based on the supplied `objectName` and `property`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">textField(<em>objectName</em>, <em>property</em> [, <em>association</em>, <em>position</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em>, <em>errorElement</em>, <em>errorClass</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>objectName</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The variable name of the object to build the form control for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the property to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>association</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>position</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>useDefaultLabel</code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>errorElement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>span</code></td>
				<td valign="top">HTML tag to wrap the form control with when the object contains errors.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>errorClass</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>fieldWithErrors</code></td>
				<td valign="top">The class name of the HTML tag that wraps the form control when there are errors.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Provide a `label` and the required `objectName` and `property` ---&gt;
&lt;cfoutput&gt;
    #textField(label=&quot;First Name&quot;, objectName=&quot;user&quot;, property=&quot;firstName&quot;)#
&lt;/cfoutput&gt;

&lt;!--- Display fields for phone numbers provided by the `phoneNumbers` association and nested properties ---&gt;
&lt;fieldset&gt;
	&lt;legend&gt;Phone Numbers&lt;/legend&gt;
	&lt;cfloop from=&quot;1&quot; to=&quot;#ArrayLen(contact.phoneNumbers)#&quot; index=&quot;i&quot;&gt;
		#textField(label=&quot;Phone ##i#&quot;, objectName=&quot;contact&quot;, association=&quot;phoneNumbers&quot;, position=i, property=&quot;phoneNumber&quot;)#
	&lt;/cfloop&gt;
&lt;/fieldset&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="textfieldtag" d:title="textFieldTag" d:parental-control="1">
		<d:index d:value="textFieldTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>textFieldTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a text field form control based on the supplied `name`. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">textFieldTag(<em>name</em> [, <em>value</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>value</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Value to populate in tag's `value` attribute.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Basic usage usually involves a `label`, `name`, and `value` ---&gt;
&lt;cfoutput&gt;
    #textFieldTag(label=&quot;Search&quot;, name=&quot;q&quot;, value=params.q)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="timeagoinwords" d:title="timeAgoInWords" d:parental-control="1">
		<d:index d:value="timeAgoInWords"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>timeAgoInWords()</code></h1>
	
		<h2>Description</h2>
		<p>Pass in a date to this method, and it will return a string describing the approximate time difference between that date and the current date.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">timeAgoInWords(<em>fromTime</em> [, <em>includeSeconds</em>, <em>toTime</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>fromTime</code></td>
				<td valign="top"><code>date</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Date to compare from.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeSeconds</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether or not to include the number of seconds in the returned string.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>toTime</code></td>
				<td valign="top"><code>date</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Date to compare to.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cfset aWhileAgo = Now() - 30&gt;
&lt;cfoutput&gt;#timeAgoInWords(aWhileAgo)#&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="timeselect" d:title="timeSelect" d:parental-control="1">
		<d:index d:value="timeSelect"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>timeSelect()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing three select form controls for hour, minute, and second based on the supplied `objectName` and `property`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">timeSelect([ <em>objectName</em>, <em>property</em>, <em>association</em>, <em>position</em>, <em>order</em>, <em>separator</em>, <em>minuteStep</em>, <em>includeBlank</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em>, <em>errorElement</em>, <em>errorClass</em>, <em>combine</em>, <em>twelveHour</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>objectName</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The variable name of the object to build the form control for.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the property to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>association</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>position</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The position used when referencing a `hasMany` relationship in the `association` argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>order</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>hour,minute,second</code></td>
				<td valign="top">Use to change the order of or exclude time select tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>separator</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>:</code></td>
				<td valign="top">Use to change the character that is displayed between the time select tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>minuteStep</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>1</code></td>
				<td valign="top">Pass in `10` to only show minute 10, 20, 30, etc.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeBlank</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, &quot;- Select One -&quot;).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">The label text to use in the form control. The label will be applied to all `select` tags, but you can pass in a list to cutomize each one individually.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>errorElement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>span</code></td>
				<td valign="top">HTML tag to wrap the form control with when the object contains errors.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>errorClass</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>fieldWithErrors</code></td>
				<td valign="top">The class name of the HTML tag that wraps the form control when there are errors.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>combine</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set to `false` to not combine the select parts into a single `DateTime` object.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>twelveHour</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- View code ---&gt;
&lt;cfoutput&gt;
    #timeSelect(objectName=&quot;business&quot;, property=&quot;openUntil&quot;)#
&lt;/cfoutput&gt;

&lt;!--- Show fields for hour and minute ---&gt;
&lt;cfoutput&gt;
	#timeSelect(objectName=&quot;business&quot;, property=&quot;openUntil&quot;, order=&quot;hour,minute&quot;)#
&lt;/cfoutput&gt;

&lt;!--- Only show 15-minute intervals ---&gt;
&lt;cfoutput&gt;
	#timeSelect(objectName=&quot;appointment&quot;, property=&quot;dateTimeStart&quot;, minuteStep=15)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="timeselecttags" d:title="timeSelectTags" d:parental-control="1">
		<d:index d:value="timeSelectTags"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>timeSelectTags()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing three select form controls for hour, minute, and second based on `name`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">timeSelectTags(<em>name</em> [, <em>selected</em>, <em>order</em>, <em>separator</em>, <em>minuteStep</em>, <em>includeBlank</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em>, <em>combine</em>, <em>twelveHour</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>selected</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Value of option that should be selected by default.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>order</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>hour,minute,second</code></td>
				<td valign="top">Use to change the order of or exclude time select tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>separator</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>:</code></td>
				<td valign="top">Use to change the character that is displayed between the time select tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>minuteStep</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>1</code></td>
				<td valign="top">Pass in `10` to only show minute 10, 20, 30, etc.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeBlank</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, &quot;- Select One -&quot;).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control. The label will be applied to all `select` tags, but you can pass in a list to cutomize each one individually.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>combine</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set to `false` to not combine the select parts into a single `DateTime` object.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>twelveHour</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- This &quot;Tag&quot; version of function accepts `name` and `selected` instead of binding to a model object ---&gt;
&lt;cfoutput&gt;
    #timeSelectTags(name=&quot;timeOfMeeting&quot; selected=params.timeOfMeeting)#
&lt;/cfoutput&gt;

&lt;!--- Show fields for `hour` and `minute` only ---&gt;
&lt;cfoutput&gt;
	#timeSelectTags(name=&quot;timeOfMeeting&quot;, selected=params.timeOfMeeting, order=&quot;hour,minute&quot;)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="timeuntilinwords" d:title="timeUntilInWords" d:parental-control="1">
		<d:index d:value="timeUntilInWords"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>timeUntilInWords()</code></h1>
	
		<h2>Description</h2>
		<p>Pass in a date to this method, and it will return a string describing the approximate time difference between the current date and that date.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">timeUntilInWords(<em>toTime</em> [, <em>includeSeconds</em>, <em>fromTime</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>toTime</code></td>
				<td valign="top"><code>date</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Date to compare to.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeSeconds</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether or not to include the number of seconds in the returned string.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>fromTime</code></td>
				<td valign="top"><code>date</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Date to compare from.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cfset aLittleAhead = Now() + 30&gt;
&lt;cfoutput&gt;#timeUntilInWords(aLittleAhead)#&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="titleize" d:title="titleize" d:parental-control="1">
		<d:index d:value="titleize"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>titleize()</code></h1>
	
		<h2>Description</h2>
		<p>Capitalizes all words in the text to create a nicer looking title.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">titleize(<em>word</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>word</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The text to turn into a title.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>#titleize(&quot;Wheels is a framework for ColdFusion&quot;)#
-&gt; Wheels Is A Framework For ColdFusion</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="toggle" d:title="toggle" d:parental-control="1">
		<d:index d:value="toggle"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>toggle()</code></h1>
	
		<h2>Description</h2>
		<p>Assigns to the property specified the opposite of the property's current boolean value. Throws an error if the property cannot be converted to a boolean value. Returns this object if save called internally is `false`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">toggle([ <em>save</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>save</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Argument to decide whether save the property after it has been toggled. Defaults to true.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get an object, and toggle a boolean property ---&gt;
&lt;cfset user = model(&quot;user&quot;).findByKey(58)&gt;
&lt;cfset isSuccess = user.toggle(&quot;isActive&quot;)&gt;&lt;!--- returns whether the object was saved properly ---&gt;
&lt;!--- You can also use a dynamic helper for this ---&gt;
&lt;cfset isSuccess = user.toggleIsActive()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="toxhtml" d:title="toXHTML" d:parental-control="1">
		<d:index d:value="toXHTML"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>toXHTML()</code></h1>
	
		<h2>Description</h2>
		<p>Returns an XHTML-compliant string.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">toXHTML(<em>text</em>)</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>text</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to make XHTML-compliant.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Outputs `productId=5&amp;amp;categoryId=12&amp;amp;returningCustomer=1` ---&gt;
&lt;cfoutput&gt;
	#toXHTML(&quot;productId=5&amp;categoryId=12&amp;returningCustomer=1&quot;)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="truncate" d:title="truncate" d:parental-control="1">
		<d:index d:value="truncate"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>truncate()</code></h1>
	
		<h2>Description</h2>
		<p>Truncates text to the specified length and replaces the last characters with the specified truncate string (which defaults to "...").</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">truncate(<em>text</em> [, <em>length</em>, <em>truncateString</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>text</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The text to truncate.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>length</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>30</code></td>
				<td valign="top">Length to truncate the text to.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>truncateString</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>...</code></td>
				<td valign="top">String to replace the last characters with.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>#truncate(text=&quot;Wheels is a framework for ColdFusion&quot;, length=20)#
-&gt; Wheels is a frame...

#truncate(text=&quot;Wheels is a framework for ColdFusion&quot;, truncateString=&quot; (more)&quot;)#
-&gt; Wheels is a framework f (more)</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="update" d:title="update" d:parental-control="1">
		<d:index d:value="update"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>update()</code></h1>
	
		<h2>Description</h2>
		<p>Updates the object with the supplied properties and saves it to the database. Returns `true` if the object was saved successfully to the database and `false` otherwise.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">update([ <em>properties</em>, <em>parameterize</em>, <em>reload</em>, <em>validate</em>, <em>transaction</em>, <em>callbacks</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>struct</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">The properties you want to set on the object (can also be passed in as named arguments).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>reload</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.)</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>validate</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to skip validations for this operation.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>transaction</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>callbacks</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to disable callbacks for this operation.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get a post object and then update its title in the database ---&gt;
&lt;cfset post = model(&quot;post&quot;).findByKey(33)&gt;
&lt;cfset post.update(title=&quot;New version of Wheels just released&quot;)&gt;

&lt;!--- Get a post object and then update its title and other properties based on what is pased in from the URL/form ---&gt;
&lt;cfset post = model(&quot;post&quot;).findByKey(params.key)&gt;
&lt;cfset post.update(title=&quot;New version of Wheels just released&quot;, properties=params.post)&gt;

&lt;!--- If you have a `hasOne` association setup from `author` to `bio`, you can do a scoped call. (The `setBio` method below will call `bio.update(authorId=anAuthor.id)` internally.) ---&gt;
&lt;cfset author = model(&quot;author&quot;).findByKey(params.authorId)&gt;
&lt;cfset bio = model(&quot;bio&quot;).findByKey(params.bioId)&gt;
&lt;cfset author.setBio(bio)&gt;

&lt;!--- If you have a `hasMany` association setup from `owner` to `car`, you can do a scoped call. (The `addCar` method below will call `car.update(ownerId=anOwner.id)` internally.) ---&gt;
&lt;cfset anOwner = model(&quot;owner&quot;).findByKey(params.ownerId)&gt;
&lt;cfset aCar = model(&quot;car&quot;).findByKey(params.carId)&gt;
&lt;cfset anOwner.addCar(aCar)&gt;

&lt;!--- If you have a `hasMany` association setup from `post` to `comment`, you can do a scoped call. (The `removeComment` method below will call `comment.update(postId=&quot;&quot;)` internally.) ---&gt;
&lt;cfset aPost = model(&quot;post&quot;).findByKey(params.postId)&gt;
&lt;cfset aComment = model(&quot;comment&quot;).findByKey(params.commentId)&gt;
&lt;cfset aPost.removeComment(aComment)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="updateall" d:title="updateAll" d:parental-control="1">
		<d:index d:value="updateAll"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>updateAll()</code></h1>
	
		<h2>Description</h2>
		<p>Updates all properties for the records that match the `where` argument. Property names and values can be passed in either using named arguments or as a struct to the `properties` argument. By default, objects will not be instantiated and therefore callbacks and validations are not invoked. You can change this behavior by passing in `instantiate=true`. This method returns the number of records that were updated.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">updateAll([ <em>where</em>, <em>include</em>, <em>properties</em>, <em>reload</em>, <em>parameterize</em>, <em>instantiate</em>, <em>validate</em>, <em>transaction</em>, <em>callbacks</em>, <em>includeSoftDeletes</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>where</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `&lt;&gt;`, `&lt;`, `&lt;=`, `&gt;`, `&gt;=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>include</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>struct</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">The properties you want to set on the object (can also be passed in as named arguments).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>reload</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.)</td>
			</tr>
			
			<tr>
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>instantiate</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether or not to instantiate the object(s) first. When objects are not instantiated, any callbacks and validations set on them will be skipped.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>validate</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to skip validations for this operation.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>transaction</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>callbacks</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to disable callbacks for this operation.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeSoftDeletes</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">You can set this argument to `true` to include soft-deleted records in the results.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Update the `published` and `publishedAt` properties for all records that have `published=0` ---&gt;
&lt;cfset recordsUpdated = model(&quot;post&quot;).updateAll(published=1, publishedAt=Now(), where=&quot;published=0&quot;)&gt;

&lt;!--- If you have a `hasMany` association setup from `post` to `comment`, you can do a scoped call. (The `removeAllComments` method below will call `model(&quot;comment&quot;).updateAll(postid=&quot;&quot;, where=&quot;postId=#post.id#&quot;)` internally.) ---&gt;
&lt;cfset aPost = model(&quot;post&quot;).findByKey(params.postId)&gt;
&lt;cfset removedSuccessfully = aPost.removeAllComments()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="updatebykey" d:title="updateByKey" d:parental-control="1">
		<d:index d:value="updateByKey"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>updateByKey()</code></h1>
	
		<h2>Description</h2>
		<p>Finds the object with the supplied key and saves it (if validation permits it) with the supplied properties and/or named arguments. Property names and values can be passed in either using named arguments or as a struct to the `properties` argument. Returns `true` if the object was found and updated successfully, `false` otherwise.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">updateByKey(<em>key</em> [, <em>properties</em>, <em>reload</em>, <em>validate</em>, <em>transaction</em>, <em>callbacks</em>, <em>includeSoftDeletes</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>key</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Primary key value(s) of the record to fetch. Separate with comma if passing in multiple primary key values. Accepts a string, list, or a numeric value.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>struct</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">The properties you want to set on the object (can also be passed in as named arguments).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>reload</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.)</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>validate</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to skip validations for this operation.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>transaction</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>callbacks</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to disable callbacks for this operation.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>includeSoftDeletes</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">You can set this argument to `true` to include soft-deleted records in the results.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Updates the object with `33` as the primary key value with values passed in through the URL/form ---&gt;
&lt;cfset result = model(&quot;post&quot;).updateByKey(33, params.post)&gt;

&lt;!--- Updates the object with `33` as the primary key using named arguments ---&gt;
&lt;cfset result = model(&quot;post&quot;).updateByKey(key=33, title=&quot;New version of Wheels just released&quot;, published=1)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="updateone" d:title="updateOne" d:parental-control="1">
		<d:index d:value="updateOne"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>updateOne()</code></h1>
	
		<h2>Description</h2>
		<p>Gets an object based on the arguments used and updates it with the supplied properties. Returns `true` if an object was found and updated successfully, `false` otherwise.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">updateOne([ <em>where</em>, <em>order</em>, <em>properties</em>, <em>reload</em>, <em>validate</em>, <em>transaction</em>, <em>callbacks</em>, <em>includeSoftDeletes</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>where</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `&lt;&gt;`, `&lt;`, `&lt;=`, `&gt;`, `&gt;=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>order</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Maps to the `ORDER BY` clause of the query. You do not need to specify the table name(s); Wheels will do that for you.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>struct</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">The properties you want to set on the object (can also be passed in as named arguments).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>reload</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Set to `true` to force Wheels to query the database even though an identical query may have been run in the same request. (The default in Wheels is to get the second query from the request-level cache.)</td>
			</tr>
			
			<tr>
				<td valign="top"><code>validate</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to skip validations for this operation.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>transaction</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>callbacks</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to disable callbacks for this operation.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>includeSoftDeletes</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">You can set this argument to `true` to include soft-deleted records in the results.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Sets the `new` property to `1` on the most recently released product ---&gt;
&lt;cfset result = model(&quot;product&quot;).updateOne(order=&quot;releaseDate DESC&quot;, new=1)&gt;

&lt;!--- If you have a `hasOne` association setup from `user` to `profile`, you can do a scoped call. (The `removeProfile` method below will call `model(&quot;profile&quot;).updateOne(where=&quot;userId=#aUser.id#&quot;, userId=&quot;&quot;)` internally.) ---&gt;
&lt;cfset aUser = model(&quot;user&quot;).findByKey(params.userId)&gt;
&lt;cfset aUser.removeProfile()&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="updateproperties" d:title="updateProperties" d:parental-control="1">
		<d:index d:value="updateProperties"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>updateProperties()</code></h1>
	
		<h2>Description</h2>
		<p>Updates all the properties from the `properties` argument or other named arguments. If the object is invalid, the save will fail and `false` will be returned.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">updateProperties([ <em>properties</em>, <em>parameterize</em>, <em>validate</em>, <em>transaction</em>, <em>callbacks</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>struct</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Struct containing key/value pairs with properties and associated values that need to be updated globally.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>validate</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to skip validations for this operation.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>transaction</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>callbacks</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to disable callbacks for this operation.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Sets the `new` property to `1` through `updateProperties()` ---&gt;
&lt;cfset product = model(&quot;product&quot;).findByKey(56)&gt;
&lt;cfset product.updateProperties(new=1)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="updateproperty" d:title="updateProperty" d:parental-control="1">
		<d:index d:value="updateProperty"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>updateProperty()</code></h1>
	
		<h2>Description</h2>
		<p>Updates a single property and saves the record without going through the normal validation procedure. This is especially useful for boolean flags on existing records.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">updateProperty(<em>property</em>, <em>value</em> [, <em>parameterize</em>, <em>transaction</em>, <em>callbacks</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>property</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the property to update the value for globally.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>value</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Value to set on the given property globally.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>parameterize</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>transaction</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[runtime expression]</code></td>
				<td valign="top">Set this to `commit` to update the database when the save has completed, `rollback` to run all the database queries but not commit them, or `none` to skip transaction handling altogether.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>callbacks</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to disable callbacks for this operation.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Sets the `new` property to `1` through updateProperty() ---&gt;
&lt;cfset product = model(&quot;product&quot;).findByKey(56)&gt;
&lt;cfset product.updateProperty(&quot;new&quot;, 1)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="urlfor" d:title="URLFor" d:parental-control="1">
		<d:index d:value="URLFor"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>URLFor()</code></h1>
	
		<h2>Description</h2>
		<p>Creates an internal URL based on supplied arguments.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">URLFor([ <em>route</em>, <em>controller</em>, <em>action</em>, <em>key</em>, <em>params</em>, <em>anchor</em>, <em>onlyPath</em>, <em>host</em>, <em>protocol</em>, <em>port</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>route</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of a route that you have configured in `config/routes.cfm`.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>controller</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the controller to include in the URL.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>action</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the action to include in the URL.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>key</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Key(s) to include in the URL.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>params</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Any additional params to be set in the query string.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>anchor</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Sets an anchor name to be appended to the path.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>onlyPath</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">If `true`, returns only the relative URL (no protocol, host name or port).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>host</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set this to override the current host.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>protocol</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set this to override the current protocol.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>port</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>0</code></td>
				<td valign="top">Set this to override the current port number.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Create the URL for the `logOut` action on the `account` controller, typically resulting in `/account/log-out` ---&gt;
#URLFor(controller=&quot;account&quot;, action=&quot;logOut&quot;)#

&lt;!--- Create a URL with an anchor set on it ---&gt;
#URLFor(action=&quot;comments&quot;, anchor=&quot;comment10&quot;)#

&lt;!--- Create a URL based on a route called `products`, which expects params for `categorySlug` and `productSlug` ---&gt;
#URLFor(route=&quot;product&quot;, categorySlug=&quot;accessories&quot;, productSlug=&quot;battery-charger&quot;)#</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="useslayout" d:title="usesLayout" d:parental-control="1">
		<d:index d:value="usesLayout"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>usesLayout()</code></h1>
	
		<h2>Description</h2>
		<p>Used within a controller's `init()` method to specify controller- or action-specific layouts.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">usesLayout(<em>template</em> [, <em>ajax</em>, <em>except</em>, <em>only</em>, <em>useDefault</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>template</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the layout template or method name you want to use</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>ajax</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of the layout template you want to use for AJAX requests</td>
			</tr>
			
			<tr>
				<td valign="top"><code>except</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">List of actions that SHOULD NOT get the layout</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>only</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">List of action that SHOULD ONLY get the layout</td>
			</tr>
			
			<tr>
				<td valign="top"><code>useDefault</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">When specifying conditions or a method, pass `true` to use the default `layout.cfm` if none of the conditions are met</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!---
	Example 1: We want this layout to be used as the default throughout the entire
	controller, except for the myajax action
 ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;cfset usesLayout(template=&quot;myLayout&quot;, except=&quot;myajax&quot;)&gt;
&lt;/cffunction&gt;

&lt;!---
	Example 2: Use a custom layout for these actions but use the default layout.cfm
	for the rest
---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;cfset usesLayout(template=&quot;myLayout&quot;, only=&quot;termsOfService,shippingPolicy&quot;)&gt;
&lt;/cffunction&gt;

&lt;!--- Example 3: Define a custom method to decide which layout to display ---&gt;
&lt;cffunction name=&quot;init&quot;&gt;
	&lt;cfset usesLayout(&quot;setLayout&quot;)&gt;
&lt;/cffunction&gt;

&lt;cffunction name=&quot;setLayout&quot;&gt;
	&lt;!--- Use holiday theme for the month of December ---&gt;
	&lt;cfif Month(Now()) eq 12&gt;
		&lt;cfreturn &quot;holiday&quot;&gt;
	&lt;!--- Otherwise, use default layout by returning `true` ---&gt;
	&lt;cfelse&gt;
		&lt;cfreturn true&gt;
	&lt;/cfif&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="valid" d:title="valid" d:parental-control="1">
		<d:index d:value="valid"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>valid()</code></h1>
	
		<h2>Description</h2>
		<p>Runs the validation on the object and returns `true` if it passes it. Wheels will run the validation process automatically whenever an object is saved to the database, but sometimes it's useful to be able to run this method to see if the object is valid without saving it to the database.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">valid([ <em>callbacks</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>callbacks</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>true</code></td>
				<td valign="top">Set to `false` to disable callbacks for this operation.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Check if a user is valid before proceeding with execution ---&gt;
&lt;cfset user = model(&quot;user&quot;).new(params.user)&gt;
&lt;cfif user.valid()&gt;
	&lt;!--- Do something here ---&gt;
&lt;/cfif&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="validate" d:title="validate" d:parental-control="1">
		<d:index d:value="validate"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>validate()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called to validate objects before they are saved.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">validate([ <em>methods</em>, <em>condition</em>, <em>unless</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names to call. (Can also be called with the `method` argument.)</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>condition</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>unless</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cffunction name=&quot;init&quot;&gt;
	&lt;!--- Register the `checkPhoneNumber` method below to be called to validate objects before they are saved ---&gt;
	&lt;cfset validate(&quot;checkPhoneNumber&quot;)&gt;
&lt;/cffunction&gt;

&lt;cffunction name=&quot;checkPhoneNumber&quot;&gt;
	&lt;!--- Make sure area code is `614` ---&gt;
	&lt;cfreturn Left(this.phoneNumber, 3) is &quot;614&quot;&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="validateoncreate" d:title="validateOnCreate" d:parental-control="1">
		<d:index d:value="validateOnCreate"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>validateOnCreate()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called to validate new objects before they are inserted.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">validateOnCreate([ <em>methods</em>, <em>condition</em>, <em>unless</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names to call. (Can also be called with the `method` argument.)</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>condition</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>unless</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cffunction name=&quot;init&quot;&gt;
	&lt;!--- Register the `checkPhoneNumber` method below to be called to validate new objects before they are inserted ---&gt;
	&lt;cfset validateOnCreate(&quot;checkPhoneNumber&quot;)&gt;
&lt;/cffunction&gt;

&lt;cffunction name=&quot;checkPhoneNumber&quot;&gt;
	&lt;!--- Make sure area code is `614` ---&gt;
	&lt;cfreturn Left(this.phoneNumber, 3) is &quot;614&quot;&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="validateonupdate" d:title="validateOnUpdate" d:parental-control="1">
		<d:index d:value="validateOnUpdate"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>validateOnUpdate()</code></h1>
	
		<h2>Description</h2>
		<p>Registers method(s) that should be called to validate existing objects before they are updated.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">validateOnUpdate([ <em>methods</em>, <em>condition</em>, <em>unless</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>methods</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Method name or list of method names to call. (Can also be called with the `method` argument.)</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>condition</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>unless</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;cffunction name=&quot;init&quot;&gt;
	&lt;!--- Register the `check` method below to be called to validate existing objects before they are updated ---&gt;
	&lt;cfset validateOnUpdate(&quot;checkPhoneNumber&quot;)&gt;
&lt;/cffunction&gt;

&lt;cffunction name=&quot;checkPhoneNumber&quot;&gt;
	&lt;!--- Make sure area code is `614` ---&gt;
	&lt;cfreturn Left(this.phoneNumber, 3) is &quot;614&quot;&gt;
&lt;/cffunction&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="validatesconfirmationof" d:title="validatesConfirmationOf" d:parental-control="1">
		<d:index d:value="validatesConfirmationOf"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>validatesConfirmationOf()</code></h1>
	
		<h2>Description</h2>
		<p>Validates that the value of the specified property also has an identical confirmation value. (This is common when having a user type in their email address a second time to confirm, confirming a password by typing it a second time, etc.) The confirmation value only exists temporarily and never gets saved to the database. By convention, the confirmation property has to be named the same as the property with "Confirmation" appended at the end. Using the password example, to confirm our `password` property, we would create a property called `passwordConfirmation`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">validatesConfirmationOf([ <em>properties</em>, <em>message</em>, <em>when</em>, <em>condition</em>, <em>unless</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of property or list of property names to validate against (can also be called with the `property` argument).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>message</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[property] should match confirmation</code></td>
				<td valign="top">Supply a custom error message here to override the built-in one.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>when</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>onSave</code></td>
				<td valign="top">Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>condition</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>unless</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Make sure that the user has to confirm their password correctly the first time they register (usually done by typing it again in a second form field) ---&gt;
&lt;cfset validatesConfirmationOf(property=&quot;password&quot;, when=&quot;onCreate&quot;, message=&quot;Your password and its confirmation do not match. Please try again.&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="validatesexclusionof" d:title="validatesExclusionOf" d:parental-control="1">
		<d:index d:value="validatesExclusionOf"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>validatesExclusionOf()</code></h1>
	
		<h2>Description</h2>
		<p>Validates that the value of the specified property does not exist in the supplied list.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">validatesExclusionOf(<em>list</em> [, <em>properties</em>, <em>message</em>, <em>when</em>, <em>allowBlank</em>, <em>condition</em>, <em>unless</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of property or list of property names to validate against (can also be called with the `property` argument).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>list</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Single value or list of values that should not be allowed.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>message</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[property] is reserved</code></td>
				<td valign="top">Supply a custom error message here to override the built-in one.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>when</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>onSave</code></td>
				<td valign="top">Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>allowBlank</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">If set to `true`, validation will be skipped if the property value is an empty string or doesn't exist at all. This is useful if you only want to run this validation after it passes the @validatesPresenceOf test, thus avoiding duplicate error messages if it doesn't.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>condition</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>unless</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Do not allow &quot;PHP&quot; or &quot;Fortran&quot; to be saved to the database as a cool language ---&gt;
&lt;cfset validatesExclusionOf(property=&quot;coolLanguage&quot;, list=&quot;php,fortran&quot;, message=&quot;Haha, you can not be serious. Try again, please.&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="validatesformatof" d:title="validatesFormatOf" d:parental-control="1">
		<d:index d:value="validatesFormatOf"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>validatesFormatOf()</code></h1>
	
		<h2>Description</h2>
		<p>Validates that the value of the specified property is formatted correctly by matching it against a regular expression using the `regEx` argument and/or against a built-in CFML validation type using the `type` argument (`creditcard`, `date`, `email`, etc.).</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">validatesFormatOf([ <em>properties</em>, <em>regEx</em>, <em>type</em>, <em>message</em>, <em>when</em>, <em>allowBlank</em>, <em>condition</em>, <em>unless</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of property or list of property names to validate against (can also be called with the `property` argument).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>regEx</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Regular expression to verify against.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>type</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">One of the following types to verify against: `creditcard`, `date`, `email`, `eurodate`, `guid`, `social_security_number`, `ssn`, `telephone`, `time`, `URL`, `USdate`, `UUID`, `variableName`, `zipcode` (will be passed through to your CFML engine's `IsValid()` function).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>message</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[property] is invalid</code></td>
				<td valign="top">Supply a custom error message here to override the built-in one.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>when</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>onSave</code></td>
				<td valign="top">Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>allowBlank</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">If set to `true`, validation will be skipped if the property value is an empty string or doesn't exist at all. This is useful if you only want to run this validation after it passes the @validatesPresenceOf test, thus avoiding duplicate error messages if it doesn't.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>condition</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>unless</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Make sure that the user has entered a correct credit card ---&gt;
&lt;cfset validatesFormatOf(property=&quot;cc&quot;, type=&quot;creditcard&quot;)&gt;

&lt;!--- Make sure that the user has entered an email address ending with the `.se` domain when the `ipCheck()` method returns `true`, and it's not Sunday. Also supply a custom error message that overrides the Wheels default one ---&gt;
&lt;cfset validatesFormatOf(property=&quot;email&quot;, regEx=&quot;^.*@.*.se$&quot;, if=&quot;ipCheck()&quot;, unless=&quot;DayOfWeek() IS 1&quot;, message=&quot;Sorry, you must have a Swedish email address to use this website.&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="validatesinclusionof" d:title="validatesInclusionOf" d:parental-control="1">
		<d:index d:value="validatesInclusionOf"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>validatesInclusionOf()</code></h1>
	
		<h2>Description</h2>
		<p>Validates that the value of the specified property exists in the supplied list.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">validatesInclusionOf(<em>list</em> [, <em>properties</em>, <em>message</em>, <em>when</em>, <em>allowBlank</em>, <em>condition</em>, <em>unless</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of property or list of property names to validate against (can also be called with the `property` argument).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>list</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">List of allowed values.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>message</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[property] is not included in the list</code></td>
				<td valign="top">Supply a custom error message here to override the built-in one.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>when</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>onSave</code></td>
				<td valign="top">Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>allowBlank</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">If set to `true`, validation will be skipped if the property value is an empty string or doesn't exist at all. This is useful if you only want to run this validation after it passes the @validatesPresenceOf test, thus avoiding duplicate error messages if it doesn't.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>condition</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>unless</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Make sure that the user selects either &quot;Wheels&quot; or &quot;Rails&quot; as their framework ---&gt;
&lt;cfset validatesInclusionOf(property=&quot;frameworkOfChoice&quot;, list=&quot;wheels,rails&quot;, message=&quot;Please try again, and this time, select a decent framework!&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="validateslengthof" d:title="validatesLengthOf" d:parental-control="1">
		<d:index d:value="validatesLengthOf"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>validatesLengthOf()</code></h1>
	
		<h2>Description</h2>
		<p>Validates that the value of the specified property matches the length requirements supplied. Use the `exactly`, `maximum`, `minimum` and `within` arguments to specify the length requirements.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">validatesLengthOf([ <em>properties</em>, <em>message</em>, <em>when</em>, <em>allowBlank</em>, <em>exactly</em>, <em>maximum</em>, <em>minimum</em>, <em>within</em>, <em>condition</em>, <em>unless</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of property or list of property names to validate against (can also be called with the `property` argument).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>message</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[property] is the wrong length</code></td>
				<td valign="top">Supply a custom error message here to override the built-in one.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>when</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>onSave</code></td>
				<td valign="top">Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>allowBlank</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">If set to `true`, validation will be skipped if the property value is an empty string or doesn't exist at all. This is useful if you only want to run this validation after it passes the @validatesPresenceOf test, thus avoiding duplicate error messages if it doesn't.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>exactly</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>0</code></td>
				<td valign="top">The exact length that the property value must be.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>maximum</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>0</code></td>
				<td valign="top">The maximum length that the property value can be.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>minimum</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>0</code></td>
				<td valign="top">The minimum length that the property value can be.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>within</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">A list of two values (minimum and maximum) that the length of the property value must fall within.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>condition</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>unless</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Make sure that the `firstname` and `lastName` properties are not more than 50 characters and use square brackets to dynamically insert the property name when the error message is displayed to the user. (The `firstName` property will be displayed as &quot;first name&quot;.) ---&gt;
&lt;cfset validatesLengthOf(properties=&quot;firstName,lastName&quot;, maximum=50, message=&quot;Please shorten your [property] please. 50 characters is the maximum length allowed.&quot;)&gt;

&lt;!--- Make sure that the `password` property is between 4 and 15 characters ---&gt;
&lt;cfset validatesLengthOf(property=&quot;password&quot;, within=&quot;4,20&quot;, message=&quot;The password length must be between 4 and 20 characters.&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="validatesnumericalityof" d:title="validatesNumericalityOf" d:parental-control="1">
		<d:index d:value="validatesNumericalityOf"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>validatesNumericalityOf()</code></h1>
	
		<h2>Description</h2>
		<p>Validates that the value of the specified property is numeric.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">validatesNumericalityOf([ <em>properties</em>, <em>message</em>, <em>when</em>, <em>allowBlank</em>, <em>onlyInteger</em>, <em>condition</em>, <em>unless</em>, <em>odd</em>, <em>even</em>, <em>greaterThan</em>, <em>greaterThanOrEqualTo</em>, <em>equalTo</em>, <em>lessThan</em>, <em>lessThanOrEqualTo</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of property or list of property names to validate against (can also be called with the `property` argument).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>message</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[property] is not a number</code></td>
				<td valign="top">Supply a custom error message here to override the built-in one.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>when</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>onSave</code></td>
				<td valign="top">Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>allowBlank</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">If set to `true`, validation will be skipped if the property value is an empty string or doesn't exist at all. This is useful if you only want to run this validation after it passes the @validatesPresenceOf test, thus avoiding duplicate error messages if it doesn't.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>onlyInteger</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Specifies whether the property value must be an integer.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>condition</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>unless</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>odd</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Specifies whether or not the value must be an odd number.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>even</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Specifies whether or not the value must be an even number.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>greaterThan</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Specifies whether or not the value must be greater than the supplied value.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>greaterThanOrEqualTo</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Specifies whether or not the value must be greater than or equal the supplied value.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>equalTo</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Specifies whether or not the value must be equal to the supplied value.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>lessThan</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Specifies whether or not the value must be less than the supplied value.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>lessThanOrEqualTo</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Specifies whether or not the value must be less than or equal the supplied value.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Make sure that the score is a number with no decimals but only when a score is supplied. (Tetting `allowBlank` to `true` means that objects are allowed to be saved without scores, typically resulting in `NULL` values being inserted in the database table) ---&gt;
&lt;cfset validatesNumericalityOf(property=&quot;score&quot;, onlyInteger=true, allowBlank=true, message=&quot;Please enter a correct score.&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="validatespresenceof" d:title="validatesPresenceOf" d:parental-control="1">
		<d:index d:value="validatesPresenceOf"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>validatesPresenceOf()</code></h1>
	
		<h2>Description</h2>
		<p>Validates that the specified property exists and that its value is not blank.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">validatesPresenceOf([ <em>properties</em>, <em>message</em>, <em>when</em>, <em>condition</em>, <em>unless</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of property or list of property names to validate against (can also be called with the `property` argument).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>message</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[property] can't be empty</code></td>
				<td valign="top">Supply a custom error message here to override the built-in one.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>when</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>onSave</code></td>
				<td valign="top">Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>condition</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>unless</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Make sure that the user data can not be saved to the database without the `emailAddress` property. (It must exist and not be an empty string) ---&gt;
&lt;cfset validatesPresenceOf(&quot;emailAddress&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="validatesuniquenessof" d:title="validatesUniquenessOf" d:parental-control="1">
		<d:index d:value="validatesUniquenessOf"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>validatesUniquenessOf()</code></h1>
	
		<h2>Description</h2>
		<p>Validates that the value of the specified property is unique in the database table. Useful for ensuring that two users can't sign up to a website with identical screen names for example. When a new record is created, a check is made to make sure that no record already exists in the database with the given value for the specified property. When the record is updated, the same check is made but disregarding the record itself.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">validatesUniquenessOf([ <em>properties</em>, <em>message</em>, <em>when</em>, <em>allowBlank</em>, <em>scope</em>, <em>condition</em>, <em>unless</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>properties</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name of property or list of property names to validate against (can also be called with the `property` argument).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>message</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>[property] has already been taken</code></td>
				<td valign="top">Supply a custom error message here to override the built-in one.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>when</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>onSave</code></td>
				<td valign="top">Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>allowBlank</code></td>
				<td valign="top"><code>boolean</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">If set to `true`, validation will be skipped if the property value is an empty string or doesn't exist at all. This is useful if you only want to run this validation after it passes the @validatesPresenceOf test, thus avoiding duplicate error messages if it doesn't.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>scope</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">One or more properties by which to limit the scope of the uniqueness constraint.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>condition</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>unless</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Make sure that two users with the same screen name won't ever exist in the database (although to be 100% safe, you should consider using database locking as well) ---&gt;
&lt;cfset validatesUniquenessOf(property=&quot;username&quot;, message=&quot;Sorry, that username is already taken.&quot;)&gt;

&lt;!--- Same as above but allow identical user names as long as they belong to a different account ---&gt;
&lt;cfset validatesUniquenessOf(property=&quot;username&quot;, scope=&quot;accountId&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="verificationchain" d:title="verificationChain" d:parental-control="1">
		<d:index d:value="verificationChain"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>verificationChain()</code></h1>
	
		<h2>Description</h2>
		<p>Returns an array of all the verifications set on this controller in the order in which they will be executed.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">verificationChain()</span></code></p>
	
		<h2>Parameters</h2>
		<p>None.</p>
	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Get verification chain, remove the first item, and set it back ---&gt;
&lt;cfset myVerificationChain = verificationChain()&gt;
&lt;cfset ArrayDeleteAt(myVerificationChain, 1)&gt;
&lt;cfset setVerificationChain(myVerificationChain)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="verifies" d:title="verifies" d:parental-control="1">
		<d:index d:value="verifies"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>verifies()</code></h1>
	
		<h2>Description</h2>
		<p>Instructs Wheels to verify that some specific criterias are met before running an action.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">verifies([ <em>only</em>, <em>except</em>, <em>post</em>, <em>get</em>, <em>ajax</em>, <em>cookie</em>, <em>session</em>, <em>params</em>, <em>handler</em>, <em>cookieTypes</em>, <em>sessionTypes</em>, <em>paramsTypes</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>only</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">List of action names to limit this verification to.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>except</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">List of action names to exclude this verification from.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>post</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set to `true` to verify that this is a `POST` request.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>get</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set to `true` to verify that this is a `GET` request.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>ajax</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Set to `true` to verify that this is an AJAX request.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>cookie</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Verify that the passed in variable name exists in the `cookie` scope.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>session</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Verify that the passed in variable name exists in the `session` scope.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>params</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Verify that the passed in variable name exists in the `params` struct.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>handler</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">Pass in the name of a function that should handle failed verifications. The default is to just abort the request when a verification fails.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>cookieTypes</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">List of types to check each listed `cookie` value against (will be passed through to your CFML engine's `IsValid` function).</td>
			</tr>
			
			<tr>
				<td valign="top"><code>sessionTypes</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">List of types to check each list `session` value against (will be passed through to your CFML engine's `IsValid` function).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>paramsTypes</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">List of types to check each `params` value against (will be passed through to your CFML engine's `IsValid` function).</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- Tell Wheels to verify that the `handleForm` action is always a `POST` request when executed ---&gt;
&lt;cfset verifies(only=&quot;handleForm&quot;, post=true)&gt;

&lt;!--- Make sure that the edit action is a `GET` request, that `userId` exists in the `params` struct, and that it's an integer ---&gt;
&lt;cfset verifies(only=&quot;edit&quot;, get=true, params=&quot;userId&quot;, paramsTypes=&quot;integer&quot;)&gt;

&lt;!--- Just like above, only this time we want to redirect the visitor to the index page of the controller if the request is invalid and show an error in The Flash ---&gt;
&lt;cfset verifies(only=&quot;edit&quot;, get=true, params=&quot;userId&quot;, paramsTypes=&quot;integer&quot;, handler=&quot;index&quot;, error=&quot;Invalid userId&quot;)&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="wordtruncate" d:title="wordTruncate" d:parental-control="1">
		<d:index d:value="wordTruncate"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>wordTruncate()</code></h1>
	
		<h2>Description</h2>
		<p>Truncates text to the specified length of words and replaces the remaining characters with the specified truncate string (which defaults to "...").</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">wordTruncate(<em>text</em> [, <em>length</em>, <em>truncateString</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>text</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">The text to truncate.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>length</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>5</code></td>
				<td valign="top">Number of words to truncate the text to.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>truncateString</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>...</code></td>
				<td valign="top">String to replace the last characters with.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>#wordTruncate(text=&quot;Wheels is a framework for ColdFusion&quot;, length=4)#
-&gt; Wheels is a framework...

#truncate(text=&quot;Wheels is a framework for ColdFusion&quot;, truncateString=&quot; (more)&quot;)#
-&gt; Wheels is a framework for (more)</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="yearselecttag" d:title="yearSelectTag" d:parental-control="1">
		<d:index d:value="yearSelectTag"/>
	
		<span class="picture">
			<img src="Images/dictionary.png" alt="CFWheels (http://cfwheels.org)" class="floatright"/>
		</span>
	
		<h1><code>yearSelectTag()</code></h1>
	
		<h2>Description</h2>
		<p>Builds and returns a string containing a select form control for a range of years based on the supplied `name`.</p>
	
		<h2>Function Syntax</h2>
	
		<p><code><span class="pre">yearSelectTag(<em>name</em> [, <em>selected</em>, <em>startYear</em>, <em>endYear</em>, <em>includeBlank</em>, <em>label</em>, <em>labelPlacement</em>, <em>prepend</em>, <em>append</em>, <em>prependToLabel</em>, <em>appendToLabel</em> ])</span></code></p>
	
		<h2>Parameters</h2>
		
	<table>
		<thead>
			<tr>
				<th>Parameter</th>
				<th>Type</th>
				<th>Required</th>
				<th>Default</th>
				<th>Description</th>
			</tr>
		</thead>
		<tbody>
			
			<tr>
				<td valign="top"><code>name</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">Yes</td>
				<td valign="top"><code></code></td>
				<td valign="top">Name to populate in tag's `name` attribute.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>selected</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The year that should be selected initially.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>startYear</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>2005</code></td>
				<td valign="top">First year in select list.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>endYear</code></td>
				<td valign="top"><code>numeric</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>2015</code></td>
				<td valign="top">Last year in select list.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>includeBlank</code></td>
				<td valign="top"><code>any</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>false</code></td>
				<td valign="top">Whether to include a blank option in the select form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, &quot;- Select One -&quot;).</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>label</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">The label text to use in the form control.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>labelPlacement</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code>around</code></td>
				<td valign="top">Whether to place the label `before`, `after`, or wrapped `around` the form control.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prepend</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>append</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr class="highlight">
				<td valign="top"><code>prependToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to prepend to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
			<tr>
				<td valign="top"><code>appendToLabel</code></td>
				<td valign="top"><code>string</code></td>
				<td valign="top" class="required">No</td>
				<td valign="top"><code></code></td>
				<td valign="top">String to append to the form control's `label`. Useful to wrap the form control with HTML tags.</td>
			</tr>
			
		</tbody>
	</table>

	
		<h2>Examples</h2>
		<code class="block">
<pre>&lt;!--- View code ---&gt;
&lt;cfoutput&gt;
    #yearSelectTag(name=&quot;yearOfBirthday&quot;, selected=params.yearOfBirthday)#
&lt;/cfoutput&gt;

&lt;!--- Only allow selection of year to be for the past 50 years, minimum being 18 years ago ---&gt;
&lt;cfset fiftyYearsAgo = Now() - 50&gt;
&lt;cfset eighteenYearsAgo = Now() - 18&gt;
&lt;cfoutput&gt;
	#yearSelectTag(name=&quot;yearOfBirthday&quot;, selected=params.yearOfBirthday, startYear=fiftyYearsAgo, endYear=eighteenYearsAgo)#
&lt;/cfoutput&gt;</pre>
		</code>
		
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->


	<d:entry id="front_back_matter" d:title="Front/Back Matter">
		<h1><b>CFWheels</b></h1>
		<h2>Front/Back Matter</h2>
		<div>
			<br/><br/>
		</div>
		<div>
		</div>
		<div>
		</div>
		<br/>
	</d:entry>

	<!-- :::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
</d:dictionary>