The Calendar control is an input control used to select date and time from a calendar. When dragging a Field of type Date/Time onto the canvas, the properties displayed will be specific to that Field.
When viewed at runtime, the different icons are used to identify the type of picker selected for the Calendar control. A date can be selected and time specified depending on the type of picker configured. The time is displayed according to the Date/Time culture settings used in respect of a 12-hour or 24-hour clock. Specify a time by clicking on the hours, minutes or seconds and using the up and down arrows. These will apply according to the intervals configured in design time. Alternatively, type the required hours, minutes or seconds. For more detail see the Picker Type and Format Time Setting sections in the Design Properties.
The Calendar control is available in the Input section of the Controls found in the View Designer and Form Designer.
Properties | Description | Can be set in runtime using Rules |
---|---|---|
Name | A unique identifier for the selected control. This property is required | No |
Field | The Field bound to the selected control. See the Binding Fields to Controls section for more information on how to use it | No |
Data Type | A drop-down list containing the types of values that the selected control can accept. See the Date/Time Use Cases section. | No |
Watermark | The text to display when the control is not populated | Yes, see Control Properties Actions for more information |
Default Value |
This property is used to populate the initial value of the Calendar control in runtime. The following values are available:
|
Yes, see Control Properties Actions for more information |
Tooltip | The value to be displayed when the cursor is hovered over the control during runtime | Yes, see Control Properties Actions for more information |
Picker Type | The Calendar picker type can be specified which includes Date, Time or Date and Time. These settings will apply when clicking on the Calendar picker in runtime | No |
Width | Adjust the width of the control (any whole percentage up to 100%, number or pixel value up to 32767px) | Yes, see Control Properties Actions for more information |
Tab Index | Used to define a sequence that users follow when they use the Tab key to navigate through a page at runtime | Yes, see Control Properties Actions for more information |
Visible | A Boolean value used to establish whether the control is visible during runtime | Yes, see Control Properties Actions for more information |
Enabled | A Boolean value used to establish whether the control is enabled during runtime | Yes, see Control Properties Actions for more information |
Read-Only | A Boolean value used to establish whether the control is read-only during runtime | Yes, see Control Properties Actions for more information |
Expression | Opens the Expression Builder to configure expressions to populate the control with dynamically calculated values | Yes, see Control Properties Actions for more information |
Styles | Opens the Style Builder enabling the user to specify style features like Format, Font, Borders, Padding and Margins. See the Style Builder topic for more information on styling options | |
Conditional Styles | Opens the Conditional Formatting Designer used to design styles that will apply only when certain conditions are met. See the Conditional Styles section for more information | No |
The Picker Type property can be set to use Date , Time or Date and Time . The Calendar will be displayed as such at runtime. The default is set to use Date. When clicking on the ellipsis next to the property, the Configure Picker Type dialog opens. Select the option or options required and set the criteria to be used with each.
Fields | Description |
---|---|
Date | |
First day of week | Represents the day when the week is started for your specific organization. When User Settings is selected, the default value of the user's browser culture settings will apply. Alternatively a specific day can be selected |
Time | |
Format time |
Defines the manner in which the time will be presented in runtime. The following options are available:
|
Minute interval |
Adjust the interval when using the up and down arrows to select minutes in the Calendar during runtime. The following intervals are available:
|
Second interval |
Adjust the interval when using the up and down arrows to select seconds in the Calendar during runtime. The following intervals are available:
|
Reset | |
Reset | Resets the values to the default system values i.e. Date and intervals of 1 |
The Calendar control allows for a 12 hour AM/PM clock or 24 hour clock to be displayed within the Calendar picker. This is useful when having customers in different countries with different culture settings. There are three items to consider when using the Calendar Picker as they work in conjunction and will influence the result at runtime.
Picker Type property - Determines the format of the Date and Time displayed in the Calendar picker at runtime and whether it's displayed as a 12 hour AM/PM clock or 24 hour clock
Date and Time Style applied to the control - Determines the display of the value in the control at runtime
Browser culture - Determines the format of the Long time and Short time
The selections made in the above items determine the display of the Calendar picker and Calendar control at runtime. The following options are available at design time for use with the Format time option of the Picker Type property:
Explanation of the notations:
h = hour
m = minute
s = second
tt = A.M or P.M
h/H = 12/24 hour
Following are examples of the different Time formats of the Calendar picker at runtime depending on the Format Time settings used:
The Display Time Zone property can be configured by using the set control properties actions allowing the designer to force a particular time zone to be used when displaying the control's value. This property can be used with the Calendar, Data Label, Text Box and Text Area controls and is configured in the Set Control properties rule actions. This property is useful if the datetime should display the same regardless of the end user location/time zone. Examples of where this feature would be beneficial are:
We're using an example of a world clock, where the user interface would state the time zone and the date time.
See the Control and Form Properties Actions topic for more detail on how to set a control's properties at runtime.
It is important to note that the Display Time Zone setting can only be configured to be affected at runtime. This means that it will only change when an event takes place at runtime. In addition, the Date and Time format of the control can further be configured using the Style Builder and the Picker Type property (only applicable to the Calendar control).
Use cases of Date, Datetime, Time, Timezone data types:
How to use rules to change the edit state of View and Form controls and tables
Video | Links | Learn | Support |
No videos found for this article K2 on YouTube
No Additional links found for this article
No self-learning content for this article Try some scenarios...
No relevant support links available for this article
|