Use ActiveX Properties to Control Scheduler's Current Selection

The Scheduler ActiveX control includes a set of properties that allow you to specify the selection that is displayed in Scheduler. Using these properties, you can:

• Select a cluster
• Select a piece of equipment
• Select one of the Scheduler tabs
• Select a special day category
• Display only the Runtime View tab
• Display or hide the Special Days View tab
• Highlight special days.

You can use the ActiveX properties in the following ways:

• Bind the ActiveX properties to a tag.

This functionality allows you to control Scheduler's current selection through changes to a tag value. For example, you could configure a button on a graphics page that displays the schedule for a particular piece of equipment.

• Use the ActiveX properties as part of a page event command.

This functionality uses Cicode to specify what is selected in Scheduler when a page event occurs, typically the On page shown event.

To bind one of Scheduler's ActiveX properties to a tag:

1. In Graphics Builder, open the page that hosts the Scheduler ActiveX control (see Open a Graphics Page).
2. Select the Scheduler ActiveX control, then right-click on it and select Properties.

The SE Energy Scheduler Control Properties dialog will appear.

3. Select the Appearance tab, then the Tag Association tab to the right.
4. In the Properties panel, select the property you would like to bind to a tag. The options are:
• SelectedCluster
• SelectedEquipment
• SelectedSpecialDayCategory
• SelectedTab
• IsRuntimeViewOnly
• IsSpecialDaysHidden
• HighlightSpecialDays.
5. In the panel labeled Associate property <property name> with tag..., enter the tag that you would like to associate with the selected property.

You can select the variable tag you would like to use by clicking on the Wizard button to the right and making a selection from the list of available tags. Alternatively, you can just key in the tag name.

6. Click OK.

Any value change to the variable tag will now be reflected in the ActiveX object property, as long as the value meets the following requirements:

• SelectedCluster — the value needs to be a string that specifies a valid cluster name (case sensitive).
• SelectedEquipment — the value needs to be a string that represents a valid equipment path with periods (.) used to specify hierarchy levels (case sensitive).
• SelectedSpecialDayCategory — the value needs to be a string that specifies a valid category name.
• SelectedTab — the value needs to be an integer between 0 and 2:
  • 0 — displays the Configuration View
  • 1 — displays Special Days View
  • 2 — displays the Runtime View.
• IsRuntimeViewOnly — the value needs to be BOOLEAN:
  • 0 — (default) displays the three tabs (Configuration View, Special Days View and Runtime View)
  • 1 — hides the Configuration View and Special Days View.
• IsSpecialDaysHidden — the value needs to be BOOLEAN:
  • 0 — (default) Special Days View is not hidden.
  • 1 — Special Days View is hidden.
• HighlightSpecialDays — the value needs to be BOOLEAN:
  • 0 — removes the orange highlight for special days.
  • 1 — (default) displays the orange highlight for special days.

To use Scheduler's ActiveX properties as part of a page event command:

1. In Graphics Builder, open the page that hosts the Scheduler ActiveX control (see Open a Graphics Page).
2. On the File menu, select Properties to display the properties for the page.
3. Select the Events tab.
4. In the Events panel, select the event you would like to associate with an ActiveX property. This is likely to be the On page shown event, as the other page events will produce illogical outcomes.
5. In the <Event> command panel, enter the required Cicode.

For example, the following Cicode (applied to the On page shown event) uses the function _ObjectSetProperty.to display the schedule for "Building.External.Light1" in the Example project.

_ObjectSetProperty(ObjectByName("AN4"),"SelectedCluster","Cluster1")

_ObjectSetProperty(ObjectByName("AN4"),"SelectedEquipment","Building.External.Light1")

6. Click OK.

See Also

Published June 2018