Date and Time Component (a!dateTimeField)

Inputs

Date and Time Component

Date and Time

Function: a!dateTimeField()

Displays and allows entry of a single date and time (year, month, day, hour, minute, second). When the field is editable, users can input dates by typing or by picking from a calendar and then select the time from a dropdown. The date and time is shown in the current user's time zone and calendar format.

When working with a date (year, month, day), use a date component. To display a time (hour, minute, second), use a time component. To display a read-only date and time using a custom format, use a text component.

Parameters

Name	Keyword	Types	Description
Label	`label`	Text	Text to display as the field label.
Instructions	`instructions`	Text	Supplemental text about this field.
Required	`required`	Boolean	Determines if a value is required to submit the form. Default: false.
Read-only	`readOnly`	Boolean	Determines if the field should display as not editable. Default: false.
Disabled	`disabled`	Boolean	Determines if the field should display as potentially editable but grayed out. Default: false.
Display Value	`value`	Date and Time	Date and time to display in the field.
Validations	`validations`	List of Text String	Validation errors to display below the field when the value is not null.
Save Input To	`saveInto`	List of Save	One or more variables that are updated with the date and time when the user changes it. Use a!save() to save a modified or alternative value to a variable.
Validation Group	`validationGroup`	Text	When present, this field is only validated when a button in the same validation group is pressed. See the documentation for more information about how to use validation groups.
Required Message	`requiredMessage`	Text	Custom message to display when the field's value is required and not provided.
Label Position	`labelPosition`	Text	Determines where the label appears. Valid values: `"ABOVE"` (default) Displays the label above the component. `"ADJACENT"` Displays the label to the left of the component. `"COLLAPSED"` Hides the label. The label will still be read by screen readers; see accessibility considerations for more information. `"JUSTIFIED"` Aligns the label alongside the component starting at the edge of the page.
Help Tooltip	`helpTooltip`	Text	Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is `"COLLAPSED"`.
Accessibility Text	`accessibilityText`	Text	Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.
Visibility	`showWhen`	Boolean	Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.

Notes

The date is shown in the current user's time zone and calendar format.
When focused in the calendar, "P" will go to the previous month, "N" will go to next month, "T" will select today's date, and "Delete" will clear the value in the field.

Examples

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

Date and Time with Only a Label

=a!dateTimeField(
  label: "Created On",
  value: datetime(2013, 1, 12, 11, 20),
  readOnly: true
)

Displays the following:

Date and Time with a Validation

=a!localVariables(
  local!storedValue:now()-1,
  a!dateTimeField(
    label: "Meeting Date and Time",
    value: local!storedValue,
    saveInto: local!storedValue,
    validations: if(
      local!storedValue <= now(),
      "Please schedule a meeting for a future date and time",
      ""
    )
  )
)

Displays the following:

Open in Github Built: Wed, Aug 17, 2022 (01:05:05 PM)

On This Page