1. General information
1.1. Description of the control
Calendar is a classic calendar ala Outlook.
1.2. Create a new control
A new calendar can be created as follows from the view page using the toolbar with controls:
- First, clicking on the view page determines the position in which the new calendar should be placed. This will highlight the selected position with a gray horizontal line. Then just click on the “Calendar” item in the toolbar of the view page, fill in the attributes of the new control in the newly opened dialog, and then save. This will insert a new calendar at a pre-selected location on the view page.
- If the desired position is not determined before inserting a new calendar, the new calendar will be inserted at the end of the view page.
1.3. Edit or delete a control
- For each existing control, a pencil icon appears to the left of the control page to change or delete the control's settings.
- Individual controls can be moved vertically on the view page using the Drag&Drop method. Moving consists of grabbing the control, preferably behind its name, and then dragging it to the desired location on the view page.
- Controls can be moved only with the “Drag&Drop” check box located above the toolbar with controls selected. For security reasons, this check box is cleared after each login to the application, so that a control is not moved by accident.
2. List of tabs in the control settings dialog
- General – Setting general properties
- Text – Settings for columns displayed in the calendar
- Tooltip – Settings for columns displayed in details
- Rights – Rights settings
- Administration – Setting other properties
2.1. “General” tab
2.1.1. Name
- The name of the control displayed in the calendar header.
2.1.2. Dictionary...
- The dictionary lists the names of other controls, forms, view pages, categories, applications, and application groups used across the entire application.
- The dictionary search is used to design the correct control name and to maintain the consistency of the nomenclature throughout the application so that controls with the same meaning located in different places in the application are named in the same way.
2.1.3. Data source
- The data source defines the source database records displayed in the calendar.
- Data source settings are made in the graphical designer of database queries. A detailed description of the database query designer is provided in the separate guide Database query designer.
2.1.4. From-To
- Select a text column that receives its default value when a new record is created by clicking on an hour in the “Hours” view. It applies only if “Allow entering new records” is checked.
- The display of events in the calendar does not depend on this column.
2.1.5. From
- Select a column that specifies the start date of the calendar event.
- The column is required and only date columns are offered. Records with an empty value are not displayed in the calendar.
2.1.6. To
- Select a column that specifies the end date of the calendar event.
- The column is required and only date columns are offered. If the value is empty, the event ends at the moment it starts; if it starts at midnight, it thus lasts the whole day. If the end is earlier than the start, the calendar swaps the two values. An end without time (at midnight) means that the event lasts until the end of that day.
2.1.7. Color
- Default color for all calendar events.
- Each event can have its own color set. In the data source settings, the “Color by” column must be set, according to which the color of the event is determined.
2.1.8. Options
- Multi-Calendar
- Checking this box determines whether the calendar should allow events from other calendars located on the view pages of the same application to be displayed.
- The calendar then displays a list of the other calendars for which the user has rights (an administrator sees all of them), completed with the “Bank holidays” item unless “Hide bank holidays” is checked. The selection of displayed calendars is saved for each user separately; until the user changes it, all calendars are displayed. The “None” selection (only the events of the calendar itself) applies only until the page is left – the next time it is opened, all calendars are displayed again.
- The events of the calendar itself are always displayed and the events of the selected calendars are added to them. Events of another calendar use its data source, columns and color; for them, “Deny opening records” follows the setting of the calendar in which they are displayed.
- Deny customization
- Checking this box determines whether individual users should be prevented from changing the selection of displayed calendars.
- The box takes effect only with “Multi-Calendar” checked. All calendars from the list are then always displayed and the list is displayed only to administrators; changing the selection in it has no effect.
- Allow entering new records
- Checking this box determines whether the user should be allowed to be redirected to a specific edit form in order to create a new record in the database by clicking on a free space in the calendar cell.
- Clicking on a free space only prefills default values and opens the edit form from which the “From” column comes; the new record is created only when the form is saved.
- In the “Days in month” and “Days in week” views, the date is prefilled in the “From” column. In the “Hours” view, the date and time are prefilled in the “From” column, a time 30 minutes later in the “To” column and its default value in the “From-To” column. The “To” and “From-To” columns are prefilled only if they belong to the same edit form as the “From” column.
- Deny opening records
- Checking this box determines whether all users should be denied access to the edit form in order to open the displayed database record by clicking on an event in the calendar.
- Hide bank holidays
- Checking this box determines whether bank holiday events retrieved from the “Settings” application should be hidden in the calendar.
2.2. “Text” tab
2.2.1. Columns
- Definition of the columns displayed in the calendar event text box.
- At least one column is required. Non-empty values are displayed in the event one after another, separated by a vertical bar (“ | ”).
2.3. “Tooltip” tab
2.3.1. Columns
- Definition of the columns of details displayed when hovering the mouse over a calendar event.
2.4. “Rights” tab
2.4.1. Rights
- Rights define a list of user groups and users who have permission to display the control on the view page.
- For a new control, the rights are prefilled from the control at the position selected before inserting it; if no position is selected, from the rights of the view page.
2.4.2. Replace rights to other controls
- The “Replace rights to other controls” feature is used to unify rights across the entire view page for controls that are related in terms of rights.
- Thanks to the “Show...” link, it is possible to display a list of all controls on the view page, including the setting of the rights of these controls. A check box is displayed for each control to select it. When the control is saved, the same rights are then set for the selected controls.
- An alternative for unifying rights within the entire view page is the overview of the rights settings of all controls, displayed by the “Show summary...” link on the “Rights” tab in the view page settings.
2.5. “Administration” tab
- The “Administration” tab is only displayed for existing controls.
2.5.1. Location
- Select the view page on which the control is located.
- The drop-down list contains the view pages located in the same application and in the same category as the view page on which the control stands. For a view page without a category, it offers only view pages without a category. For a new control, it contains only the current view page.
2.6. “Save”, “Delete”, and “Close” buttons
- “Save” button – Saves changes to the control settings.
- “Delete” button – Permanently deletes the control.
- “Close” button – Closes the control settings dialog without saving changes.
3. Working with the calendar
- The calendar offers the Days in month, Days in week and Hours views. The “Hours” view shows one day divided into half-hours, always from 6:00 to 23:00; earlier and later times are displayed only if an event extends into them. An event that starts before the displayed day and ends after it is displayed as a bar above the time axis.
- The calendar remembers the selected view and the first day of the week for each user separately. The displayed date is restored when printing, after returning from an edit form opened by clicking an event in the calendar, and if the user worked with the calendar within the last 10 minutes; otherwise the calendar opens on the current day.
- In the “Days in month” view, clicking the name of a weekday makes it the first day of the week. Clicking a date in the “Days in month” and “Days in week” views switches the calendar to the “Hours” view of that day.
- The “Search” icon in the title of the calendar moves to a selected date. The “Print...” icon is offered only on a computer, not on a mobile device.
- Events taking place on the current day are displayed in bold. The tooltip with the details of an event is not displayed on a mobile device or in print.
- The settings of the calendar and the selection of displayed calendars are not saved for the anonymous user.