A calendar control is a basic control that allows user to select dates and/or times for data entry. Each calendar control must be associated with a Single Named Range (SNR) in the workbook.
The Named Range property lists of all Single Named Ranges (SNR) from the workbook. The value entered into this input will be sent to the calculation engine, as if the user entered the value into the spreadsheet model.
Selecting a named range from the list may default some of the other calendar control properties based on some metadata captured from the spreadsheet model, such as the default value. Named ranges containing formulas are excluded from the list, as well as named ranges that have already been bound to a different input in your user interface.
The Name property constitutes the label that will appear in the user interface. Other properties, such as Placeholder, will also derive their dynamic {FriendlyName} value from this property.
The Placeholder property defines the text that will be visible in the calendar control when no input has been entered. This will only appear if no default value is selected or if the user clears the input’s value.
This property supposed the special {FriendlyName} tag to insert the value of the Name property into the placeholder.
The Size property denotes the size of the calendar control in the user interface. Note that altering the style of calendar controles via Cascading Style Sheets (CSS) may affect whether or not the size property is visibly relevant in your published application.
The Label Horizontal Alignment property determines the horizontal orientation of the label. This value can be set to Left, Center, or Right. The default horizontal alignment is Left.
The Label Vertical Alignment property determines the vertical orientation of the label. This value can be set to Top, Middle, or Bottom. The default vertical alignment is Middle.
The Label Size property is the spacing distribution of the input control’s label vs. the input control. The maximum width of both controls cumulatively is considered to be 12 – a width of 12 for the label would indicate that the label occupies a full row within its container and the input control occupies a full row beneath it.
Any label distribution below 12 will indicate that the label and the input control occupy the same row in the user interface. The label’s width will be used to calculate the control’s width such that the two controls cumulatively occupy the full width of 12.
For example, setting the Label Size to 6 will indicate that the control width is also 6. This means the label will occupy 50% the width of the row and the control will occupy 50% the width of the row.
Likewise, setting the Label Size to 3 will indicate that the control width is 9, meaning that the label will occupy 25% the width of the row while the input control occupies 75% the width of the row.
Setting the Label Size to 0 will hide the label in the user interface.
The Default Value property specifies the value that will be visible in this calendar control when the user interface is first loaded. This property may have a suggestion populated if the target named range for the calendar control includes a default value.
The Start Date property specifies the first day or first time can be selected from calendar control. Start date cannot be greater than Default Value. If you are going to use calendar control as time picker and you want to define start time and end time that user can select from time picker you need to set same date as Start Date and End Date, then you can set time for time picker control.
The End Date property specifies the last day or last time can be selected from calendar control. End date cannot be less than Default Value
The Disable Day(s) of Week property specifies day(s) that will not allowed in user interface. You can’t select more than 6 days to disable days.
Tooltips are informative message boxes that are displayed when you mouse-over or click on a control. The Tooltip Type property determines the message style, and when the information will be shown.
- Tooltip: The content will appear in a small bubble when the user enters focus on the target input by moving their mouse over the control.
- Popover: The content will appear in a pop-up box when the user clicks on the target input.
If Trigger Calculations is selected, changing the value in this input control will trigger a calculation. Calculations perform a server call with all of the inputs from the user interface and populate the output controls with the values from the updated calculation.
In workbooks with complex calculations, enabling calculations may lead to delays in the user experience.
The best practice when determining whether an input should trigger calculations should take into account the following factors:
- Does this input affect any calculated values? If the field is simply informational, then there is no reason to trigger a calculation.
- Does this input affect my user interface? If the field can change the visibility or enabled-ness of pages or other controls, then it is a good idea to trigger calculations when changes occur to the input.
- Will something else trigger calculations before this input is relevant? If the user won’t see the results of the calculations until reaching a different page, then you can hold off on triggering calculations until a button press or a different control’s value is changed.
The Date/Time Format property will determine the masking of the value entered in the control, as well as the available picker controls when the field is focused. The available options are as follows:
- Default: Both the date and time will be selectable from the control when focused, including the time zone. The time will include hours, minutes, seconds, and AM/PM flag.
- US Long Date: Both the date and time will be selectable from the control when focused, excluding the time zone. The time will include hours, minutes, seconds, and AM/PM flag. This is oriented towards United States formatting, which includes the month first, followed by the day (i.e. MM/DD).
- EU Long Date: Both the date and time will be selectable from the control when focused, excluding the time zone. The time will include hours, minutes, seconds, and AM/PM flag. This is oriented towards the global formatting, which includes the day first, followed by the month (i.e. DD/MM).
- Long Time: Only the time will be selectable from the control when focused, excluding the time zone. The time will include hours, minutes, seconds, and AM/PM flag.
- US Short Date: Only the date will be selectable from the control when focused. This is oriented towards United States formatting, which includes the month first, followed by the day (i.e. MM/DD).
- EU Short Date: Only the date will be selectable from the control when focused. This is oriented towards the global formatting, which includes the day first, followed by the month (i.e. DD/MM).
- Short Time: Only the time will be selectable from the control when focused.
Enabled indicates whether the calendar control field is enabled. Visible indicates whether the calendar control field is visible.
Enabled, and Visible can be configured as Always or Never to indicate whether the input is statically enabled or not. Alternatively, if any Boolean Single Named Ranges (SNR) exist (i.e. ranges pointing to a single cell that evaluates to TRUE or FALSE), then the enabled-ness of the input can be configured to reflect the value of that named range using the ‘By Value Of’ setting.