Table of Contents

UI XML Template

The view graphical interface is described as XML independent of the rendering technology (HTML, HTMLUI framework, ...).

Data binding

Data binding in templates allow you to dynamically access and display data within your UI view or UI components. By using the @ character, you can bind properties and functions directly in your templates, enabling real-time updates and interactions.

To find out more about all the properties and functions of the UI view which can be accessed, read this article.

Standard components

Standard components are pre-built elements provided by the framework that can be easily integrated into your UI view. The list is available in the Template > Standard components section of the left-hand menu. You can also consult them here:

Bound and unbound inputs

Most input components can be used in two ways: bound, through the property-name attribute, or unbound, through the value attribute. The attribute tables of each component are split accordingly: Bound and Unbound list the attributes specific to each usage, while Common lists the attributes available in both.

On a bound input, the attributes listed under Unbound (label, placeholder, required, documentation, ...) are ignored, because these values come from the metadata of the bound property. Setting any of them next to property-name raises a generation warning. Each of these attributes has its counterpart in the metadata of the property, which is where the value must be defined instead: a placeholder, for instance, comes from the Placeholder metadata.

Directives

Directives are special attributes which can be used on template nodes in order to apply a specific behavior. They are not specific to a component, unlike attributes, but are transversal. They must be prefixed by the namespace in order to be recognized. Example with layout :

<form-field property-name="CustomerName" layout:width="25" />

The list is available in the Template > Directives section of the left-hand menu.

Snippets

Snippets are XML blocks that can be quickly inserted into a template. They appear as suggestions when the user starts typing code. Example: Inserting groupbox components by typing gb followed by the Tab key in the template. To find out more about snippets, read this article.

Toolbox

The toolbox lists the available components within your cluster. Users can drag and drop elements into the template for easy integration.

How to

The Template > ❔ How to section provides a series of articles that explain how to build standard template in the UI view. You can find them in the left-hand menu.