---
title: "Applets - EventsScheduler"
canonical: "https://docs.cuesystem.com/space/CVCGC/448921606/Applets%20-%20EventsScheduler"
format: markdown
---
> Macro (toc)
---
# Description
In Applet EventsScheduler, in Properties, you can choose one of 39 Picture features and Name. Name may be up to 15 characters long. In EventSchedulerUI in each particular TouchPanel, you can only use Events, which are filled in the Controller Applet EventsScheduler Properties. Respectively the Event becomes usable, if it has assigned Picture, Name or both. Maximum number of Events is 20, each Event has its eventnumber.
# Picture
| | | | | | |
| --- | --- | --- | --- | --- | --- |
| Picture | Name | Picture | Name | Picture | Name |
|  | Animals |  | Garden |  | Sauna |
|  | AudioVideo |  | Gate Close |  | SecurityLock |
|  | Blind Close |  | Gate Open |  | SecurityUnlock |
|  | Blind Open |  | Heating1 |  | Temperature |
|  | Boiler |  | Heating2 |  | TemperatureHigh |
|  | Camera |  | Henhouse |  | TemperatureLow |
|  | Day |  | LightFluorescent |  | TemperatureMedium |
|  | Door Close |  | LightIncandescent |  | Ventilation off |
|  | DoorOpen |  | LightLED |  | Ventilation on |
|  | Energy |  | Night |  | Water off |
|  | Fish |  | Photovoltaic |  | Water on |
|  | Flame |  | Pool |  | Window close |
|  | Garage |  | Projection |  | Window open |
# Properties
| | | | | |
| --- | --- | --- | --- | --- |
| Property Name | Data Type | Allowed Values | Default Value | Description |
| ObjectID | Long | 1 - 10 | 1 | All setting changed during runtime in the Applet object is stored in the EventSchedulers Applet file storage in file EventScheduler_xx.cfg, where xx is ObjectID of EventScheduler instance.
If you have more instances of EventScheduler Applet object in one controller, set different ObjectID for every instance. You can use up to 10 instances of object in one controller. |
| SchedulerName | As AddressOf
Text | Any | Nothing | Scheduler may be named. SchedulerName may be up to 50 characters long. |
| Event1 |
| Picture | Long | ##### 1 = Animals 20 = LightFluorescent
2 = AudioVideo 21 = LightIncandescent
3 = Blind Close 22 = LightLED
4 = Blind Open 23 = Night
5 = Boiler 24 = Photovoltaic
6 = Camera 25 = Pool
7 = Day 26 = Projection
8 = Door Close 27 = Sauna
9 = Door Open 28 = Security Lock
10 = Energy 29 = Security Unlock
11 = Fish 30 = Temperature
12 = Flame 31 = TemperatureHigh
13 = Garage 32 = TemperatureLow
14 = Garden 33 = TemperatureMedium
15 = Gate Close 34 = Ventilation off
16 = Gate Open 35 = Ventilation on
17 = Heating1 36 = Water off
18 = Heating2 37 = Water on
19 = Henhouse 38 = Window close
39 = Window open | Nothing | Event picture. |
| Name | As AddressOf
Text | Any | Nothing | Name may be up to 15 characters long. |
| ...
Event20 |
# Functions
## GetEventName
This function returns AddressOf Text of the event eventnumber name in ByRef parameter eventname. This function return True on succes or false if an error occurs (event must be defined in the object properties).
#### Syntax
```visualbasic
Function GetEventName(
eventnumber As Long,
ByRef eventname As AddressOf Text)
As Boolean
```
> 📝 The following functions are used in the EventSchedulerInterface module and is not expected to use them anywhere else in the program.
## GetSchedulerPlansAndEvents
This Function returns the current plans of EventsScheduler and events of EventsScheduler. This function must be called, when the OnGetPlansAndEvents by graphic class EventSchedulerUI is generated.
#### Syntax
```visualbasic
Function GetSchedulerPlansAndEvents(
plans As AddressOf SchedulerPlans,
events As AddressOf SchedulerEvent)
```
[Descriptions of structures](https://cue.atlassian.net/wiki/spaces/CVCGC/pages/448921606/Applets+-+EventsScheduler#Descriptions-of-structure)
## IsActive
This function returns True if the Controller is active.
#### Syntax
```visualbasic
Function IsActive() As Boolean
```
## SetSchedulerPlan
This function saves your plans and generates an event OnPlanChange. This function must be called, when OnSchedulerChangePlan by graphic class EventSchedulerUI is generated.
#### Syntax
```visualbasic
Function SetSchedulerPlan(plans As SchedulerPlans)
```
[Description of structre of SchedulerPlans](https://cue.atlassian.net/wiki/spaces/CVCGC/pages/448921606/Applets+-+EventsScheduler#Descriptions-of-structure)
# Events
## OnEvent1 - 20
This event is generated when the time of the Event comes.
#### Syntax
```visualbasic
Event OnEvent1 - 20 As Process()
```
> 📝 The following events are used in the EventSchedulerInterface module and is not expected to use them anywhere else in the program.
## OnHeartbeat
This event is generated each second when the Applet EventsScheduler is active. In this process, call function of graphic classes EventSchedulerUI Heartbeat().
#### Syntax
```visualbasic
Event OnHeartbeat As Process()
```
## OnPlanChange
This event is generated when there is a change of plan. In this process, call function of graphic classes EventSchedulerUI SetPlan(newplan).
#### Syntax
```visualbasic
Event OnPlanChange As Process(newplan As SchedulerPlans)
```
# Descriptions of structure
```visualbasic
Public Structure SchedulerPlans
Var WeekPlan [7] As Long
Var Plans[MAXPLANS] As ShedulerPlan
End Structure
```
```visualbasic
Public Structure ShedulerPlan
Var NamePlan As Text [15]
Var TimeSplitter[COUNTOFSPLITTERS] As _TimeStructure
Var LeftBorder[COUNTOFSPLITTERS] As Boolean
Var RightBorder[COUNTOFSPLITTERS] As Boolean
Var Eventindex[COUNTOFSPLITTERS] As Long
Var IsUsed As Boolean
Var PositionJ As Long
Var ActualPlanPosition As Long
End Structure
```
```visualbasic
Public Structure SchedulerEvent
Var EventPicture[COUNTOFEVENT] As AddressOf _Picture
Var EventPictureIndex[COUNTOFEVENT] As Long
Var EventText[COUNTOFEVENT] As Text [15]
Var MaxEventNum As Long
Var EventIndex[COUNTOFEVENT] As Long
Var SchedulerName As AddressOf Text
End Structure
```