You are viewing documentation for v1.1.x. Change

timeSelectTags()

Description

Builds and returns a string containing three select form controls for hour, minute, and second based on name.

Function Syntax

timeSelectTags(name [, selected, order, separator, minuteStep, includeBlank, label, labelPlacement, prepend, append, prependToLabel, appendToLabel, combine, twelveHour ])

Parameters

Parameter Type Required Default Description
name string Yes Name to populate in tag's name attribute.
selected string No Value of option that should be selected by default.
order string No hour,minute,second Use to change the order of or exclude time select tags.
separator string No : Use to change the character that is displayed between the time select tags.
minuteStep numeric No 1 Pass in 10 to only show minute 10, 20, 30, etc.
includeBlank any No false 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, "- Select One -").
label string No 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.
labelPlacement string No around Whether to place the label before, after, or wrapped around the form control.
prepend string No String to prepend to the form control. Useful to wrap the form control with HTML tags.
append string No String to append to the form control. Useful to wrap the form control with HTML tags.
prependToLabel string No String to prepend to the form control's label. Useful to wrap the form control with HTML tags.
appendToLabel string No String to append to the form control's label. Useful to wrap the form control with HTML tags.
combine boolean No Set to false to not combine the select parts into a single DateTime object.
twelveHour boolean No false whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs

Examples

<!--- This "Tag" version of function accepts `name` and `selected` instead of binding to a model object --->
<cfoutput>
#timeSelectTags(name="timeOfMeeting" selected=params.timeOfMeeting)#
</cfoutput>

<!--- Show fields for `hour` and `minute` only --->
<cfoutput>
    #timeSelectTags(name="timeOfMeeting", selected=params.timeOfMeeting, order="hour,minute")#
</cfoutput>