Header
The header is a UserControl and serves as an entry point for users. It offers an easy way to configure a navigation for the HMI and several other features.
Features
The features at a glance (from left to right).
- Logo (1)
- Responsive navigation (2)
- User settings and further information (3)
- Event list (4)
- Building information (5)
- Outdoor temperature (6)
- Date and time (7)
User settings and further information
In this menu, the user can make various settings and display dialogs:
- Setting the language
- Setting the theme
- Show diagnostic data of the BaSiteExtension
- Show dialog with icon legend
- Updating the general object information that is not updated cyclically (e.g. description, active text, status texts)
- List for displaying and editing the calendar objects in the project
- Show server log
Event list
The event list can be accessed via the button with the bell symbol. The button also shows the number of active events if the number was linked via the EventCount attribute.
Building information
The button with the info symbol is the control BuildingInformation.
It can be used to open a window with information about the building and the facades.
Attributes
The control inherits from TcHmiControl and thus has the same attributes. In addition, there are the following attributes.
Logo
tchmi:framework#/definitions/ContentPath
Path specification to the image with the logo that is displayed at the start of the header.
MenuData
tchmi:framework#/definitions/TcHmi.Controls.ResponsiveNavigation.TcHmiNavigationBar.MenuItemList
Defines the structure and hierarchy of the navigation. Entries in the header can be linked directly to content pages, or submenus can be created that expand when selected.
SwitchBreakpoint
tchmi:general#/definitions/Number
Determines at which pixel width the navigation changes to the Hamburger symbol.
EventCount
tchmi:general#/definitions/Number
Here you can link a symbol that contains the number of active events in the event list. This number is then displayed in a badge on the button for the event list.
CurrentTemperature
tchmi:general#/definitions/Number
Current temperature to be displayed in the header. Typically, the outside temperature is displayed here.
CurrentTemperatureUnit
tchmi:general#/definitions/String
Unit of the current temperature.
CloseMenu
tchmi:general#/definitions/Boolean
If the attribute has the value TRUE, the header menus can be closed (this can be changed during runtime).
NavContent
tchmi:framework#/definitions/TcHmi.Controls.ResponsiveNavigation.TcHmiNavigationContent
Content to display in the responsive navigation.
UserContent
tchmi:framework#/definitions/TcHmi.Controls.ResponsiveNavigation.TcHmiNavigationContent
Content for display in the user menu.
TargetRegion
tchmi:framework#/definitions/TcHmiRegion
The TcHmiRegion must be linked here, which is used to display the content pages selected from the menu.
EventContent
tchmi:framework#/definitions/ContentPath
Content on which the event list is located.
StartPage
tchmi:framework#/definitions/ContentPath
Start page of the HMI. This page is loaded into the TargetRegion when you click the logo.