Show TOC

Preprocessing InstructionsLocate this document in the navigation structure

You can use an XML view as a template that is transformed by an XML preprocessor on the source level, that is, the XML DOM, before an SAPUI5 control tree is created from that XML source.

See the example and introduction in the topic XML Templating in SAPUI5.

In the example, the models available to the preprocessor are initially as follows. Note how a model name can be seen as a variable with a value that consists of two pieces: a model instance and a binding context's path.

meta = oMetaModel, "/dataServices/schema/0/entityType/0"

You can base conditions on the available variables. XML attributes that represent an available binding are replaced automatically. The <template:with> instruction can be used to change a variable's value or to add a variable with a new name. Likewise, the <template:repeat> instruction deals with its loop variable. When a fragment is inlined, the current variable assignment is propagated into the fragment's content and so on. Preprocessing instructions are inserted in XML syntax and assigned to the XML namespace http://schemas.sap.com/sapui5/extension/sap.ui.core.template/1, which is referred to by the namespace prefix template in the code samples.


In this section:
    with
    The <template:with> instruction can be used to change a variable's value or to add a variable with a new name.
    repeat
    The <template:repeat instruction iterates the sap.ui.model.ListBinding given by the list attribute.
    if
    The <template:if> instruction evaluates a condition expressed via existing SAPUI5 data binding features, such as extended syntax; in the preprocessing it is removed or replaced by its child elements based on the value of this condition.
    Replacement of Bindings
    For attributes, you do not need templating instructions but use SAPUI5 binding expressions instead as in the below code snippet. Each XML attribute is checked to see if its value represents a valid SAPUI5 binding which refers to currently available model (= <variable>) names only. If so, the binding is evaluated and the result is written back into that XML attribute.
    XML Fragments
    SAPUI5 fragments of type XML are used in the context of XML templating to provide reuse parts for templates.