DateTimeFields property
The date and time fields of this form group as an array.
Accessing all date and time fields of a form group through this property has many uses:
- Finding the latest date represented by the date and time fields of a form group.
- Enabling a button only if all date and time fields of a form group are valid.
- Deciding which background color to use based on whether the date and time fields of a form group are valid.
- Collecting the labels and values of all date and time fields of a form group as a text string, for use as the body of an email.
- Only allowing a user to move forward to the next screen if they have filled out all date and time fields of a form group.
The following sections detail how these scenarios can be realized. Skip to the examples at the bottom for the concise version.
Finding the latest date
This formula returns the latest date represented by the values of the date and time fields of the form group:
The formula above can also be written as follows:
However, as the MAX function is looking for an array of numbers, and date and time fields return numbers through their Value properties, .Value,Value is inferred and does not need to be spelled out.
Finding the latest date from other date and time fields
Let's say that the form group FormGroup1 consists of ten date and time fields, Field1 through Field10. If Field10 should contain the latest date of the other date and time fields, it is tempting to try to associate this formula with the Value property of Field10:
However, that formula will not work. Instead, you'll get an error message, because you're effectively asking that the calculated value of Field10 includes the value of Field10 itself.
This is similar to trying to use the formula NumberField1 * 2NumberField1 * 2 for the Value property of NumberField1, effectively asking that the value of NumberField1 should be set to the value of NumberField1, multiplied by two. This is known as a circular calculation, and results in an error message.
In order to solve this issue, the formula needs to reference the date and time fields to include in the calculation explicitly:
Above, Field1:Field9Field1:Field9 creates an array consisting of Field1, Field9 and all items that appear between them. Notably, Field10 is not part of the array.
Enabling a button only if all date and time fields are valid
The Enabled property of a button determines if users can interact with the button. If a button should only be enabled if all date and time fields of FormGroup1 are considered valid, associate this formula with the Enabled property of the button:
Above, the FormGroup1.DateTimeFields.ValidFormGroup1,DateTimeFields,Valid formula returns an array of logical values (TRUE or FALSE), where TRUE indicates that a date and time field is valid and FALSE indicates that a date and time field is invalid. The AND function, when applied to this array, returns TRUE only if all array elements are TRUE. In effect, the button is only enabled if all date and time fields of the form group are valid.
Making the background color red if a date and time field is invalid
The BackgroundColor property determines the background color of a screen and all screens that follow that have no explicit background color set. That means that if the background color is set for the first screen of an app, and no other screens have a background color set, the first screen determines the background color of the entire app.
We can make use of this knowledge to make the background of the entire app red, but only if at least one date and time field of the form group FormGroup1 is invalid. This formula is associated with the BackgroundColor property of the first screen:
The formula fragment FormGroup1.DateTimeFields.ValidFormGroup1,DateTimeFields,Valid returns a logical array, where TRUE indicates that the corresponding date and time field is valid and FALSE indicates that the corresponding date and time field is invalid. Applying the NOT function to this array negates every element, meaning that TRUE indicates that a date and time field is invalid and FALSE indicates that a date and time field is valid. (The ! operator would have had the same effect.)
Then, the OR function is applied to this array. It returns FALSE only if all elements of the array are FALSE. In other words, it returns TRUE if one or several elements are TRUE, meaning that it returns TRUE if one or several date and time fields are invalid.
Finally, the IF function is used to return the color red if one or several date and time fields are invalid. Otherwise, IF returns a blank value, which has no effect on the background color. The net effect is that the background color of the app is made red if one or several date and time fields of FormGroup1 are invalid.
Including all date and time field values of a form group in an email
The Body property of email report buttons allows the body of an email to be set through a formula. While email report buttons have built-in support for including field values, through the IncludedFields property, building a text string manually to include in the email body allows us more flexibility.
Consider this formula, which should be associated with the Body property of an email report button:
Above, the formula fragment FormGroup1.DateTimeFields.LabelFormGroup1,DateTimeFields,Label returns a text array, made up of the labels of the date and time fields of FormGroup1. The formula fragment FormGroup1.DateTimeFields.FormattedValueFormGroup1,DateTimeFields,FormattedValue also returns an array, this time made up of the formatted values of the date and time fields. Using &, the labels are joined together with the formatted values, separated by a colon.
The resulting text array, where every element consists of a label, followed by a colon and a value, is converted into a single text string using the TEXTJOIN function. Its first parameter, NEWLINE()NEWLINE(), ensures that the array elements are separated from one another using line breaks.
Requiring all date and time fields of a form group to be filled out
The NextScreenAvailable property of form screens determines if users are allowed to move forward to the next screen. If a user should only be allowed to move forward once all date and time fields of a form group have been filled out, associate this formula with the NextScreenAvailable property of the screen that the form group is part of:
The ISDEFINED function returns a logical array when its sole parameter is an array. TRUE elements in the array indicate that the corresponding date and time fields have defined values, that is, have been filled out, and FALSE elements indicate that the corresponding date and time fields have not been filled out.
Finally, the AND function returns TRUE only if all elements of the array are TRUE, otherwise it returns FALSE. The net effect is that AND returns TRUE only if all date and time fields of FormGroup1 have been filled out, prompting the NextScreenAvailable property to only allow users to proceed once all date and time fields have defined values.
Ranges versus this property
If the form group FormGroup1 only consists of the date and time fields Field1, Field2 and Field3, these formulas are equivalent:
The second formula uses a range to create an array consisting of Field1, Field3 and all items that appear between them, which in this case is only Field2.
The chief advantage of the DateTimeFields property, compared to a range, is that there is no need to update formulas when additional date and time fields are added to a form group. If Field4 were to be added to the form group, the Field1:Field3Field1:Field3 range would have to be changed to Field1:Field4Field1:Field4 everywhere it is used.
By contrast, FormGroup1.DateTimeFieldsFormGroup1,DateTimeFields automatically includes Field4, and any other date and time fields that are added.
Filtering date and time fields
If you want to process only a subset of the date and time fields returned from this property, use the FILTER function. It can base its decision on which date and time fields to return on the property values of the date and time fields.
This formula only returns visible date and time fields:
Crucially, you can also filter on the names of the date and time fields, using standard text functions. This formula only returns date and time fields whose names include the text string "Required":
If you use a deliberate naming strategy for your date and time fields, you can use FILTER in conjunction with this property to ensure that you only process a specific subset of date and time fields.
Related properties
Use the DateTimeFields property of a screen to access all date and time fields of said screen and the DateTimeFields property of the app object to access all date and time fields of the entire app.
The Fields property returns all fields of a form group, not just date and time fields. The Items property returns all items of a form group, including fields, buttons, text boxes and named values. Use NumberFields, TextFields, SwitchFields, NumberDropDownFields and TextDropDownFields to access other kinds of fields.
Examples
Returns the latest date represented by the date and time fields that belong to FormGroup1.
Returns the latest date represented by the date and time fields that belong to FormGroup1. If .Value,Value is left out, it is inferred.
Returns the latest date represented by the date and time fields that belong to FormGroup1 or FormGroup2.
Returns TRUE if all date and time fields of FormGroup1 are valid and FALSE otherwise. FormGroup1.DateTimeFields.ValidFormGroup1,DateTimeFields,Valid returns a logical array, where each element reflects whether its corresponding date and time field is valid. Finally, the AND function returns TRUE if all elements are TRUE and FALSE otherwise.
Returns all formatted values of a form group's date and time fields as a text string, where values are separated from one another using line breaks. The formula fragment FormGroup1.DateTimeFields.FormattedValueFormGroup1,DateTimeFields,FormattedValue returns an array of formatted values, which the TEXTJOIN function joins together with line breaks.
Returns TRUE if all date and time fields of FormGroup1 have been filled out. When the ISDEFINED function is applied to an array of date and time fields, it returns a logical array whose elements indicate if the corresponding date and time field has a defined value. The AND function returns TRUE if all array elements are TRUE and FALSE otherwise.