Legend

The Legend control displays all icons on the active web page with their description.

Use

Use on any page where you want to display an explanation of the icons.

Features

Provides static and dynamic display of icons and allows adding additional icons.

Display

The icons can be displayed statically on the web page or dynamically (event-driven) by calling the OpenLegendDialog function.

Legend 1:

Additional icons

Local

Additional icons can be added to the respective instance of the legend via the IconDataCustom attribute. When the function is called, the attribute is in the parameter list.

Global

Icons to be displayed by each legend instance must be added via a TwinCAT HMI Internal Symbol.

The symbol must have the name BaLegendIconDataList and be of type

TcHmi.BuildingAutomation.Controls.BuildingGeneral.Legend.IconDataList
Legend 2:

Attributes

The control inherits from BaseControl and thus has the same attributes. In addition, there are the following attributes.

Common

ShowHeadline

tchmi:general#/definitions/Boolean

Sets the visibility of the title.

EntryWidth

tchmi:framework#/definitions/MeasurementValue

Width of an entry.

EntryWidthUnit

tchmi:framework#/definitions/MeasurementUnit

Unit of width of an entry.

TabPosition

tchmi:framework#/definitions/TcHmi.BuildingAutomation.Position

Position of the tabs.

IconDataSource

tchmi:framework#/definitions/TcHmi.BuildingAutomation.Controls.BuildingGeneral.Legend.IconDataSource

Selection of entries to be displayed.

IconDataCustom

tchmi:framework#/definitions/TcHmi.BuildingAutomation.Controls.BuildingGeneral.Legend.IconDataList

List with additional entries.