The visible time range in the schedule
Usage
Set_Property(OLECtrlEntID, "OLE.TimeRange", Array)
Values
Array has the following structure:
| Pos | Name | Type | Description | Default |
|---|---|---|---|---|
| <1> | Start Time | Integer | The visible starting time | 0 |
| <2> | End Time | Integer | The visible end time | 24 |
| <3> | Time Label Factor | Integer | The number of hours to display an hour label | 1 |
Remarks
The TimeRange property can be used to limit how much of the day, in hours, is visible to the user. By default, the user can see from 12:00am to 11:59pm in one day. The values passed into the range are in hours, with 0 being 12:00am and 24 being 11:59pm.
The property will perform checks and balances to insure the range is normalize. The start hour cannot be greater or equal than the end hour. If such values are passed, then the end hour will be calculated to 1 hour passed the start hour.
The hours will also be truncated to fit with bounds. The start hour must be between 0 and 23. The end hour must be between 1 and 24. Any attempt to go outside these bounds will cause the property to recalculate them to fit within the bounds.
In all cases, the property will ensure that at least one hour is visible to the user.
Time Label Factor
This field is only used in the MultiDayHorz View. When set to 1, then the current hour is displayed every hour. When set to 3, then the current hour is displayed every 3 hours.
Example
// Only show the user 8am to 5pm Set_Property(@Window:".OLE_SCHEDULE", "OLE.TimeRange", 8:@FM:17) // Show the whole day, but only display midnight and noon times (only works in MultiDayHorz View) Set_Property(@Window:".OLE_SCHEDULE", "OLE.TimeRange", 0:@FM:24:@FM:12)
