Use ActiveX Properties to Control Scheduler's Current Selection

You can use the Scheduler ActiveX Control properties to customize the Scheduler Page in Runtime as per the requirement. Using these properties, you can:

• Select a cluster

• Select an equipment

• Select one of the Scheduler tabs

• Select a special day category

• Show only the Runtime View tab

• Show or hide the Special Days View tab

• Highlight special days

• Show or hide the Add button in the Categories panel on the Special Days View tab.

You can use the ActiveX properties in the following ways:

• Binding one of the Scheduler's ActiveX properties to a tag.

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

Binding one of Scheduler's ActiveX properties to a tag:

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

To bind the scheduler's ActiveX properties to a tag perform the following steps:

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.

3. The SE Energy Scheduler Control Properties dialog box appears. Select the Appearance tab, and then the Tag Association tab on the right side.

4. Select one of the following options available in the Properties panel:

   • SelectedCluster

   • SelectedEquipment

   • SelectedSpecialDayCategory

   • SelectedTab

   • IsRuntimeViewOnly

   • IsSpecialDaysHidden

   • HighlightSpecialDays

   • IsAddSpecialDaysButtonVisible

5. In the panel labeled Associate property <property name> with tag..., enter the tag that you need to associate with the selected property.

   Refer to ActiveX Object Properties - Appearance (Tag Association) and associate a tag, or type a tag name.

6. Click OK.

Any value change to the associated variable tag reflects in the ActiveX object property, if the value meets the following requirements:

• SelectedCluster — The value is a string that specifies a valid cluster name (case sensitive).

• SelectedEquipment — The value is a string that represents a valid equipment path with periods (.) used to specify hierarchy levels (case sensitive).

• SelectedSpecialDayCategory — The value is a string that specifies a valid category name.

• SelectedTab — The value is an integer between 0 and 2:

  • 0 — Shows the Configuration View tab.

  • 1 — Shows Special Days View tab.

  • 2 — Shows the Runtime View tab.

• IsRuntimeViewOnly — The value is a boolean:

  • 0 (default) — Shows three tabs (Configuration View, Special Days View and Runtime View).

  • 1 — Hides the Configuration View and the Special Days View tab.

• IsSpecialDaysHidden — The value is a boolean:

  • 0 (default) — Shows the Special Days View tab.

  • 1 — Hides the Special Days View tab.

• HighlightSpecialDays — The value is a boolean:

  • 0 — Does not highlight special days.

  • 1 (default) — Highlights the special days in orange.

• IsAddSpecialDaysButtonVisible — The value is a boolean:

  • 0 — Hides the Add button in the Categories panel on the Special Days View tab.

  • 1 (default) — Shows the Add button in the Categories panel on the Special Days View tab.

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

This functionality uses Cicode to specify the Scheduler selection when a page event occurs, typically the On page shown event.

To use Scheduler's ActiveX properties as part of a page event command perform the following steps:

7. In the Graphics Builder, open the page that hosts the Scheduler ActiveX control (see Open a Graphics Page).

8. Go to the File menu and select Properties to display the page properties.

9. Select the Events tab.

10. In the Events panel, select the event you need to associate with an ActiveX property. This is likely to be the On page shown event, as the other page events may produce illogical outcomes.

11. 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")

12. Click OK.

See Also

Tag Association